prerelease

README.md

@@ -6,10 +6,14 @@
 
 ![git-secret terminal preview](https://raw.githubusercontent.com/sobolevn/git-secret/gh-pages/images/gitsecret_terminal.gif)
 
-## Installation and Usage
+## Usage
 
 See the [git-secret site](https://sobolevn.github.io/git-secret/).
 
+## Installation
+
+See the [installation section](https://sobolevn.github.io/git-secret/#installation).
+
 ## Status
 
 This project is still under development. Current objectives:
@@ -17,15 +21,19 @@ This project is still under development. Current objectives:
 - add `trust-model` parameter to `git-secret-hide`
 - autocomplete for `zsh` plugin
 - extra tests
-- precompiled distributions for `brew` and other package managers
-- create `CONTRIBUTING.md` with custom styleguide, refactor code due to styleguide
+- precompiled distribution for `RPM`
+- integrate [`shellcheck`](https://github.com/koalaman/shellcheck) for code style tests
+- create `CONTRIBUTING.md` with development process explained
 - сygwin support (?)
 
-
 ## Testing
 
-For testing this project uses [`bats`](1). You can install it by running `make install-test`.
+For testing this project uses [`bats`](https://github.com/sstephenson/bats). You can install it by running `make install-test`.
 To run tests call: `make test`. It will download and install `bats` into `vendor/bats` if it's not installed yet.
 
 
-[1]: https://github.com/sstephenson/bats
+## Changelog
+
+### Version 0.1.0
+
+- Initial release

man/man7/git-secret.7.ronn

@@ -39,18 +39,31 @@ You can add you platform to this list, if all the tests passes for you.
 
 There are several ways to install `git-secret`:
 
-**The hard way**
+**Brew**
 
-1. Clone the repository first: `git clone https://github.com/sobolevn/git-secret.git git-secret`
-2. Run `cd git-secret && make build`
-3. Move `git-secret` file and `man/` folder somewhere inside your `$PATH`, or extend your `$PATH` to contain `git-secret` file and `man/` folder
+1. Run `brew install sobolevn/tap/git-secret`
 
 **`antigen` plugin (or any other `oh-my-zsh`-styled plugin-systems)**
 
 1. Add line `antigen bundle sobolevn/git-secret` to your `.zshrc`
 2. Run `source ~/.zshrc` or reopen the terminal
 
-`brew` and `fpm` support is planned.
+**`make install`**
+
+1. Download the latest realease [here](https://github.com/sobolevn/git-secret/releases)
+2. Unpack and run `make install PREFIX="your/installation/path"`, note that this command may require `sudo`
+
+**The hard way**
+
+1. Clone the repository first: `git clone https://github.com/sobolevn/git-secret.git git-secret`
+2. Run `cd git-secret && make build`
+3. Move `git-secret` file and `man/` folder somewhere inside your `$PATH`, or extend your `$PATH` to contain `git-secret` file and `man/` folder
+
+**Local `.deb` package**
+
+1. Download the latest realease [here](https://github.com/sobolevn/git-secret/releases)
+2. Unpack, and run `make build-deb`, it is possible to set the output folder with `$SCRIPT_BUILD_DIR` variable.
+3. Install the local `.deb` package with `dpkp -i git-secret-package-name.deb`, note that this command may require `sudo` and the package name will be different
 
 ## Usage
 These steps cover the basic process of using `git-secret`: