Add info about new Glow version to README

This commit is contained in:
Christian Rocha 2020-08-27 13:32:05 -04:00 committed by Christian Muehlhaeuser
commit dde57403c6

View file

@ -19,10 +19,13 @@ Render markdown on the CLI, with _pizzazz_!
Glow is a terminal based markdown reader designed from the ground up to bring
out the beauty—and power—of the CLI.
Use it to quickly discover markdown files in a folder (it will automatically
search subdirectories for you), read documentation directly on the command line
and stash markdown files to your own private collection in the Charm Cloud so
you can read them anywhere.
Use it to discover markdown files, read documentation directly on the command
line and stash markdown files to your own private collection so you can read
them anywhere. Glow it will find markdown files in subdirectories for, if
youre in a Git repo, search the repo.
By the way, all data stashed is encrypted end-to-end: only you can decrypt it.
More on that below.
## Installation
@ -45,7 +48,7 @@ nix-env -iA nixpkgs.glow
pkg install glow
```
Or download a binary from the [releases][] page. MacOS, Linux, FreeBSD
Or download a binary from the [releases][releases] page. MacOS, Linux, FreeBSD
binaries are available, as well as Debian and RPM packages. ARM builds are also
available for Linux and FreeBSD.
@ -60,7 +63,9 @@ go get github.com/charmbracelet/glow
## Usage
Use a markdown source as the primary argument:
Run without arguments to start the TUI and browser local and stashed markdown.
Or, to simply format a document on the CLI, use a markdown source as the
primary argument:
```bash
# Read from file
@ -76,9 +81,6 @@ glow github.com/charmbracelet/glow
glow https://host.tld/file.md
```
When `glow` is started without a markdown source, it will try to find a
`README.md` or `README` file in the current working directory.
### Stashing
Glow works with the Charm Cloud to allow you to store any markdown file in your
@ -88,9 +90,10 @@ own private collection. When you run:
You'll add that markdown file to your stash. Running `glow` without arguments
will let you browse through all your stashed documents. This is a great way to
keep track of documentation that you need to reference.
keep track of things that you need to reference often.
Stashing is private and your stash and its contents will not be exposed publicly.
Stashing is private, its contents will not be exposed publicly, and it's
encrypted end-to-end. More on encryption below.
### Word Wrapping
@ -121,25 +124,34 @@ Alternatively you can also supply a custom JSON stylesheet:
glow -s mystyle.json
```
Check out the [Glamour Style Section](https://github.com/charmbracelet/glamour/blob/master/styles/gallery/README.md)
to find more styles. Or [make your own](https://github.com/charmbracelet/glamour/tree/master/styles)!
***
For additional usage details see:
```bash
glow --help
```
Check out the [Glamour Style Section](https://github.com/charmbracelet/glamour/blob/master/styles/gallery/README.md)
to find more styles. Or [make your own](https://github.com/charmbracelet/glamour/tree/master/styles)!
## 🔒 Encryption: how it works
Encryption works by issuing symmetric keys (basically a generated password) and
encrypting it with the local SSH public key generated by the open-source
[charm][charmlib] library. That encrypted key is then sent up to our server.
We cant read it since we dont have your private key. When you want to decrypt
something or view your stash, that key is downloaded from our server and
decrypted locally using the SSH private key. When you link accounts, the
symmetric key is encrypted for each new public key. This happens on your
machine and not our server, so we never see any unencrypted data.
[charmlib]: https://github.com/charmbracelet/charm
## License
[MIT](https://github.com/charmbracelet/glow/raw/master/LICENSE)
***
Part of [Charm](https://charm.sh).
<img alt="the Charm logo" src="https://stuff.charm.sh/charm-badge.jpg" width="400">
Charm热爱开源!
Charm loves open source! / Charm热爱开源!