diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-02-19 18:20:36 -0600 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-02-19 18:20:36 -0600 |
| commit | 3a4794860b3cc5323a8b7e4b34bef5b48f5ce776 (patch) | |
| tree | 94e281ed4ff9348cdfdfb0e9a3748bbbb1798835 /docs | |
| parent | 6d869c1b2fdc9dc20f90a5b520896b01a0f9011b (diff) | |
| parent | 5809d48ef8a1ab125fcff140847bf44c6fe3a91d (diff) | |
| download | cryptography-3a4794860b3cc5323a8b7e4b34bef5b48f5ce776.tar.gz cryptography-3a4794860b3cc5323a8b7e4b34bef5b48f5ce776.tar.bz2 cryptography-3a4794860b3cc5323a8b7e4b34bef5b48f5ce776.zip | |
Merge pull request #639 from alex/faq
Add an FAQ page to the docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/faq.rst | 18 | ||||
| -rw-r--r-- | docs/index.rst | 4 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 1 |
3 files changed, 23 insertions, 0 deletions
diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 00000000..cbbb74ad --- /dev/null +++ b/docs/faq.rst @@ -0,0 +1,18 @@ +Frequently Asked Questions +========================== + +How does ``cryptography`` compare to NaCl (Networking and Cryptography Library)? +-------------------------------------------------------------------------------- + +While ``cryptography`` and `NaCl`_ both share the goal of making cryptography +easier, and safer, to use for developers, ``cryptography`` is designed to be a +general purpose library, interoperable with existing systems, while NaCl +features a collection of hand selected algorithms. + +``cryptography``'s :ref:`recipes <cryptography-layout>` layer has similar goals +to NaCl. + +If you prefer NaCl's design, we highly recommend `PyNaCl`_. + +.. _`NaCl`: http://nacl.cr.yp.to/ +.. _`PyNaCl`: https://pynacl.readthedocs.org diff --git a/docs/index.rst b/docs/index.rst index c8ef41b6..176405b5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,6 +33,9 @@ existing libraries: * Poor introspectability, and thus poor testability. * Extremely error prone APIs, and bad defaults. + +.. _cryptography-layout: + Layout ------ @@ -60,6 +63,7 @@ The recipes layer fernet random-numbers exceptions + faq glossary The hazardous materials layer diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 14b0b773..9bc84e50 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -18,6 +18,7 @@ fernet Fernet hazmat indistinguishability +interoperable introspectability invariants iOS |