git-secret/README.md

40 lines
1.1 KiB
Markdown
Raw Normal View History

2016-02-21 13:26:17 +00:00
# git-secret
[![Build Status](https://secure.travis-ci.org/sobolevn/git-secret.png?branch=master)](https://travis-ci.org/sobolevn/git-secret)
2016-02-24 11:24:07 +00:00
## Preview
![git-secret terminal preview](https://raw.githubusercontent.com/sobolevn/git-secret/gh-pages/images/gitsecret_terminal.gif)
2016-03-13 10:06:18 +00:00
## Usage
2016-02-24 11:24:07 +00:00
See the [git-secret site](https://sobolevn.github.io/git-secret/).
2016-03-13 10:06:18 +00:00
## Installation
See the [installation section](https://sobolevn.github.io/git-secret/#installation).
2016-02-21 13:26:17 +00:00
## Status
This project is still under development. Current objectives:
- add `trust-model` parameter to `git-secret-hide`
- autocomplete for `zsh` plugin
2016-02-21 13:26:17 +00:00
- extra tests
2016-03-13 10:06:18 +00:00
- precompiled distribution for `RPM`
- integrate [`shellcheck`](https://github.com/koalaman/shellcheck) for code style tests
- create `CONTRIBUTING.md` with development process explained
2016-02-21 13:26:17 +00:00
- сygwin support (?)
## Testing
2016-03-13 10:06:18 +00:00
For testing this project uses [`bats`](https://github.com/sstephenson/bats). You can install it by running `make install-test`.
2016-03-12 19:21:04 +00:00
To run tests call: `make test`. It will download and install `bats` into `vendor/bats` if it's not installed yet.
2016-02-21 13:26:17 +00:00
2016-03-13 10:06:18 +00:00
## Changelog
### Version 0.1.0
- Initial release