Skip to content

Commit

Permalink
chore(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rogerthebest committed Jul 17, 2021
1 parent 62b1166 commit cdde8bc
Showing 1 changed file with 45 additions and 2 deletions.
47 changes: 45 additions & 2 deletions README.md
Expand Up @@ -4,10 +4,14 @@
</a>
</p>

<div align="center">🔐 Share end-to-end encrypted secrets with others via a one-time URL</div>
<p align="right">
<i>If you use this repo, star it ✨</i>
</p>

***

<div align="center">🔐 Share end-to-end encrypted secrets with others via a one-time URL</div>

## Install

### Homebrew
Expand All @@ -30,6 +34,45 @@ brew upgrade sniptt-official/ots/ots

For manual installation instructions on macOS and Linux, please refer to the dedicated [install docs](./docs/manual-install.md).

## Usage

### Prompt

```sh
$ ots new -x 2h
Enter your secret:
```

### Pipeline

You can also use pipes, for example

```sh
$ pbpaste | ots new
```

or

```sh
$ cat .env | ots new
```

## Security

### Why should I trust you with my secrets?

All secrets are **end-to-end encrypted**, which means the plaintext values **never leave your device**. We do *not* log, track, share, or store the encryption key that protects your secret. You can check the client code to learn more about how we create the encryption key as well as what data is being sent to our servers.

### Is sharing via URL really secure?

Secrets created using the `ots new` command are what we refer to as "one-time secrets". Once they are retrieved by the recipient, they can no longer be viewed even if someone got hold of the URL. Furthermore, each one-time secret gets automatically deleted after specified duration if not viewed. By default, this is 24 hours but you can set yours, for example `ots new -x 2h`.

However, it goes without saying that URL-accessible one-time secrets should be shared with **intended recipients only**.

### Can I persist my secrets for later use?

Please use the [snip-cli](https://github.com/sniptt-official/snip-cli) instead.

## License

This project is under the Apache-2.0 license.
See [LICENSE](LICENSE)

0 comments on commit cdde8bc

Please sign in to comment.