From de06b2930b5421cba6049a03daec6e818d7ec374 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 18 Feb 2014 16:40:09 -0800 Subject: Add an FAQ page to teh docs --- docs/faq.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/faq.rst (limited to 'docs/faq.rst') diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 00000000..9c8dff96 --- /dev/null +++ b/docs/faq.rst @@ -0,0 +1,17 @@ +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, capable of interoperating with existing systems, while +NaCl features a collection of hand selected algorithms. + +``cryptography``'s recipes layer is similar in design to NaCl. + +If you prefer NaCl's design, we highly recommend `PyNaCl`_. + +.. _`NaCl`: http://nacl.cr.yp.to/ +.. _`PyNaCl`: https://pynacl.readthedocs.org -- cgit v1.2.3 From c37adab9bd2b8af22a0d198d883f18ac4c6b8d27 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 18 Feb 2014 16:46:58 -0800 Subject: Use a real word --- docs/faq.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/faq.rst') diff --git a/docs/faq.rst b/docs/faq.rst index 9c8dff96..41742a2a 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -6,8 +6,8 @@ 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, capable of interoperating with existing systems, while -NaCl features a collection of hand selected algorithms. +general purpose library, interoperable with existing systems, while NaCl +features a collection of hand selected algorithms. ``cryptography``'s recipes layer is similar in design to NaCl. -- cgit v1.2.3 From 59a6bc68d4ca7846d065007611618d5957ffd188 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 18 Feb 2014 18:13:48 -0800 Subject: Capitalization and linkification --- docs/faq.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/faq.rst') diff --git a/docs/faq.rst b/docs/faq.rst index 41742a2a..13743ce1 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,7 +1,7 @@ Frequently Asked Questions ========================== -How does ``cryptography`` compare to NaCl (Networking and Cryptography library)? +How does ``cryptography`` compare to NaCl (Networking and Cryptography Library)? -------------------------------------------------------------------------------- While ``cryptography`` and `NaCl`_ both share the goal of making cryptography @@ -9,7 +9,8 @@ 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 recipes layer is similar in design to NaCl. +``cryptography``'s :ref:`recipes ` layer is similar in +design to NaCl. If you prefer NaCl's design, we highly recommend `PyNaCl`_. -- cgit v1.2.3 From 5809d48ef8a1ab125fcff140847bf44c6fe3a91d Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Wed, 19 Feb 2014 13:33:18 -0800 Subject: Try to be more precise --- docs/faq.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/faq.rst') diff --git a/docs/faq.rst b/docs/faq.rst index 13743ce1..cbbb74ad 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -9,8 +9,8 @@ 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 ` layer is similar in -design to NaCl. +``cryptography``'s :ref:`recipes ` layer has similar goals +to NaCl. If you prefer NaCl's design, we highly recommend `PyNaCl`_. -- cgit v1.2.3