mirror of
https://github.com/sobolevn/git-secret
synced 2024-11-06 15:20:36 +00:00
00deabb0e3
Changes: 1. Now everything is tested inside the `docker`-containers and `OSX` images on `travis`. 2. We now have `CONTRIBUTING.md` and `LICENSE.md`. `README.md` is also changed. 3. We have a brand logo. 4. We have autodeploy to `bintray`. 5. Everything is `shellcheck`ed (except `tests/`). Closes #32 #33 #34 #35 #39
38 lines
1.8 KiB
Markdown
38 lines
1.8 KiB
Markdown
# git-secret
|
||
|
||
[![Build Status](https://img.shields.io/travis/sobolevn/git-secret/master.svg)](https://travis-ci.org/sobolevn/git-secret) [![Homebrew](https://img.shields.io/homebrew/v/git-secret.svg)](http://braumeister.org/formula/git-secret) [![Bintray deb](https://img.shields.io/bintray/v/sobolevn/deb/git-secret.svg)](https://bintray.com/sobolevn/deb/git-secret/view) [![Dockerhub](https://img.shields.io/docker/pulls/sobolevn/git-secret.svg)](https://hub.docker.com/r/sobolevn/git-secret/)
|
||
|
||
[![git-secret](https://raw.githubusercontent.com/sobolevn/git-secret/gh-pages/images/git-secret-big.png)](https://sobolevn.github.io/git-secret/)
|
||
|
||
## What is `git-secret`?
|
||
|
||
`git-secret` is a bash tool to store your private data inside a git repo. How’s that? Basically, it just encrypts, using `gpg`, the tracked files with the public keys of all the users that you trust. So everyone of them can decrypt these files using only their personal secret key. Why deal with all this private-public keys stuff? Well, to make it easier for everyone to manage access rights. There are no passwords that change. When someone is out - just delete his public key, re-encrypt the files, and he won’t be able to decrypt secrets anymore.
|
||
|
||
## 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).
|
||
|
||
## Contributing
|
||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
||
|
||
## Changelog
|
||
|
||
See [CHANGELOG.md](CHANGELOG.md).
|
||
|
||
## License
|
||
|
||
MIT. See [LICENSE.md](LICENSE.md) for details.
|
||
|
||
## Thanks
|
||
|
||
Special thanks to [Elio Qoshi](https://elioqoshi.me/sq/) from [ura](http://ura.al/) for the awesome logo.
|