Skip to content

Commit

Permalink
Update readme to confrom with the current features
Browse files Browse the repository at this point in the history
  • Loading branch information
tzeikob committed Jun 2, 2021
1 parent 18c6775 commit d6f9eef
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 8 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,45 @@
# Releaze

This is an experimental cli package to be used as utility for release side tasks.
This is an experimental package to be used as utility for side tasks related to releasing and publishing new versions.

## How to install

In order to instal you can use NPM like so:
In order to instal the package globally you should execute the following command:

```sh
npm install releaze
npm install -g releaze
```

## How to use

Assuming you have installed the cli package in a git NPM/Node repository.

Being in the project's root folder, you can print all the commit messages by running the following command.
Assuming you have installed the package globally, change to the directory of your git repository. Being in the project's root folder, you can print all the commit messages by running the following command:

```sh
releaze changelog
```

Another option could be to define a hash range within each commit should fall in, like so.
this command will print every commit message from your git repository in the following format:

```
...
e8a36dd Reorganize package properties plus various demographics
880a599 Set the version and environment of the ES
371664a First commit
Wow, that was a DRY output of 103 commits!
```

### Limit commits in a given range

Another use case could be to limit the range of commits given a starting and ending point. The starting point should be given via the argument `from` and the end point via the argument `to`, both arguments is expected to be a commit hash or a git tag.

```sh
releaze changelog --from <hash or tag> --to <hash or tag>
```

Bear in mind that you don't have to provided both arguments, you can use for instance only the `from` where the commit range should be limited to those starting from the given hash or tag otherwise you can use only the `to` argument to print only the commits up to the given has or tag.

## Get help

You can always get more information about the usage and options applied to the client.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "releaze",
"version": "0.1.0",
"author": "Jake Ob <iakopap@gmail.com>",
"description": "A experimental package to bump up NPM packages",
"description": "A experimental package to release new versions",
"keywords": [
"versioning",
"changelog",
Expand Down

0 comments on commit d6f9eef

Please sign in to comment.