README.md in sym-2.7.0 vs README.md in sym-2.8.0
- old
+ new
@@ -1,15 +1,17 @@
# Sym — Light-weight Symmetric Encryption for Humans
[](https://badge.fury.io/rb/sym)
-[](https://rubygems.org/gems/sym)
+[](https://rubygems.org/gems/sym)
[](https://travis-ci.org/kigster/sym)
[](https://codeclimate.com/github/kigster/sym)
[](https://codeclimate.com/github/kigster/sym/coverage)
[](https://codeclimate.com/github/kigster/sym)
+**Discuss Sym on Gitter**:
+
[](https://gitter.im/kigster/sym)
---
**March 10th, 2017**. Please checkout the post "**[Dead Simple Encryption with Sym](http://kig.re/2017/03/10/dead-simple-encryption-with-sym.html)**" that announces this library, and provides further in-depth discussion.
@@ -28,14 +30,28 @@
<p>Unlike many existing encryption tools, <strong>sym</strong> focuses on narrowing the gap between convenience and security, by offering enhanced usability and a streamlined ruby API and a CLI. The primary goal of the library is to make encryption very easy and transparent. </p>
<p><strong>sym</strong> uses the <em><a href="https://en.wikipedia.org/wiki/Symmetric-key_algorithm">Symmetric Encryption</a></em> algorithm. This means that the same key is used to encrypt and decrypt data. In addition to the key, the encryption uses a randomized IV vector, which is automatically generated per each encryption and serialized with the data. Result of encryption is zlib-compressed, and base64 encoded, to be suitable for storage as string. The generated keys are also base64-encoded for convenience.</p>
-<p>Finally, the library offers encryption using any regular password, and in particular supports password-protected encryption keys. The key can be specified by a filename, environment variable, or OS-X Keychain password entry name, or as is.</p>
+<p>Finally, the library offers encryption using any regular password, and in particular supports password-protected encryption keys. Automatic key detection algorithm attempts to resolve a provided key as a filename, an environment variable name, an OS-X Keychain password entry name, a key itself, or a default key file.</p>
</div>
+### Quick Demo of the CLI in Action
+
+[](https://asciinema.org/a/106737)
+
+
+#### Help Screens, Examples and Symit Bash Wrapper
+
+This may be a good time to take a look at the full help message for the `sym` tool, shown naturally with a `-h` or `--help` option. Examples can be shown with `-E/--examples` flag.
+
+Additionally, Sym comes with a helpful BASH wrapper `symit`.
+
+**Help screens for `sym` and `symit` are shown in full on another page — [Sym Help Screens and Symit](SYM-CLI.md). Please refer to it for complete help screens and the examples.**
+
+
## Supported Ruby Versions
[](https://travis-ci.org/kigster/sym)
Sym currently builds and runs on the following ruby versions:
@@ -499,16 +515,10 @@
# Or edit the encrypted file:
sym -Atf file.enc
```
-#### CLI Help Screen and Examples
-
-This may be a good time to take a look at the full help message for the `sym` tool, shown naturally with a `-h` or `--help` option. Examples can be shown with `-E/--examples` flag.
-
-Please take a look at the [SYM-CLI](SYM-CLI.md) for a complete help screen and the examples.
-
## Fine Tuning
<a name="rubyapi-config"></a>
### Configuration
@@ -609,6 +619,5 @@
* [Wissam Jarjoui](https://github.com/bosswissam) (testing, inspiration)
* [Megan Mathews](https://github.com/meganmmathews) (UX, CLI suggestions)
* [Barry Anderson](https://twitter.com/z3ndrag0n) (sanity checking, review)
-