You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
git-secret/README.md

39 lines
1.2 KiB
Markdown

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# git-secret
[![Build Status](https://secure.travis-ci.org/sobolevn/git-secret.png?branch=master)](https://travis-ci.org/sobolevn/git-secret)
## Preview
[![git-secret terminal preview](https://asciinema.org/a/41811.png)](https://asciinema.org/a/41811?autoplay=1)
## 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:
- add `trust-model` parameter to `git-secret-hide`
- translate manuals for popular languages
- autocomplete for `zsh` plugin
- extra tests
- precompiled distribution for `RPM`, add dependencies for `.deb` package
- 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`](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.
## Changelog
See [CHANGELOG.md](CHANGELOG.md)