summaryrefslogtreecommitdiffhomepage
path: root/sites/www/index.rst
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2014-01-30 10:40:35 -0800
committerJeff Forcier <jeff@bitprophet.org>2014-01-30 10:40:35 -0800
commit8cc9ae059ffa6e484d24149ff7508555bfaed1b6 (patch)
treed9c8dde5cfb2537e83ffedad1e3490608c9943b2 /sites/www/index.rst
parent935c55dd1f596f97bd8c3d76dd8abfe9cffaa8b0 (diff)
parenta83f0d3038e8d16e7c160293d16c2736645564d6 (diff)
Merge branch '1.11' into 1.12
Diffstat (limited to 'sites/www/index.rst')
-rw-r--r--sites/www/index.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/sites/www/index.rst b/sites/www/index.rst
new file mode 100644
index 00000000..7fefedd2
--- /dev/null
+++ b/sites/www/index.rst
@@ -0,0 +1,38 @@
+Welcome to Paramiko!
+====================
+
+Paramiko is a Python (2.5+) implementation of the SSHv2 protocol [#]_,
+providing both client and server functionality. While it leverages a Python C
+extension for low level cryptography (`PyCrypto <http://pycrypto.org>`_),
+Paramiko itself is a pure Python interface around SSH networking concepts.
+
+This website covers project information for Paramiko such as the changelog,
+contribution guidelines, development roadmap, news/blog, and so forth. Detailed
+usage and API documentation can be found at our code documentation site,
+`docs.paramiko.org <http://docs.paramiko.org>`_.
+
+.. toctree::
+ changelog
+ installing
+ contributing
+ contact
+
+.. Hide blog in hidden toctree for now (to avoid warnings.)
+
+.. toctree::
+ :hidden:
+
+ blog
+
+
+.. rubric:: Footnotes
+
+.. [#]
+ SSH is defined in RFCs
+ `4251 <http://www.rfc-editor.org/rfc/rfc4251.txt>`_,
+ `4252 <http://www.rfc-editor.org/rfc/rfc4252.txt>`_,
+ `4253 <http://www.rfc-editor.org/rfc/rfc4253.txt>`_, and
+ `4254 <http://www.rfc-editor.org/rfc/rfc4254.txt>`_;
+ the primary working implementation of the protocol is the `OpenSSH project
+ <http://openssh.org>`_. Paramiko implements a large portion of the SSH
+ feature set, but there are occasional gaps.