Merge pull request #651 from letsencrypt/update_readme

Update README
This commit is contained in:
James Kasten
2015-08-05 12:04:34 -07:00
+19 -15
View File
@@ -1,12 +1,18 @@
.. notice for github users .. notice for github users
Official **documentation**, including `installation instructions`_, is Disclaimer
available at https://letsencrypt.readthedocs.org. ==========
Generic information about Let's Encrypt project can be found at This is a **DEVELOPER PREVIEW** intended for developers and testers only.
https://letsencrypt.org. Please read `Frequently Asked Questions (FAQ)
<https://letsencrypt.org/faq/>`_.
**DO NOT RUN THIS CODE ON A PRODUCTION SERVER. IT WILL INSTALL CERTIFICATES
SIGNED BY A TEST CA, AND WILL CAUSE CERT WARNINGS FOR USERS.**
Browser-trusted certificates will be available in the coming months.
For more information regarding the status of the project, please see
https://letsencrypt.org. Be sure to checkout the
`Frequently Asked Questions (FAQ) <https://letsencrypt.org/faq/>`_.
About the Let's Encrypt Client About the Let's Encrypt Client
============================== ==============================
@@ -18,7 +24,7 @@ In short: getting and installing SSL/TLS certificates made easy (`watch demo vid
The Let's Encrypt Client is a tool to automatically receive and install The Let's Encrypt Client is a tool to automatically receive and install
X.509 certificates to enable TLS on servers. The client will X.509 certificates to enable TLS on servers. The client will
interoperate with the Let's Encrypt CA which will be issuing browser-trusted interoperate with the Let's Encrypt CA which will be issuing browser-trusted
certificates for free beginning the summer of 2015. certificates for free.
It's all automated: It's all automated:
@@ -67,15 +73,6 @@ server automatically!::
.. _watch demo video: https://www.youtube.com/watch?v=Gas_sSB-5SU .. _watch demo video: https://www.youtube.com/watch?v=Gas_sSB-5SU
Disclaimer
----------
This is a **DEVELOPER PREVIEW** intended for developers and testers only.
**DO NOT RUN THIS CODE ON A PRODUCTION SERVER. IT WILL INSTALL CERTIFICATES
SIGNED BY A TEST CA, AND WILL CAUSE CERT WARNINGS FOR USERS.**
Current Features Current Features
---------------- ----------------
@@ -99,6 +96,13 @@ Current Features
* Free and Open Source Software, made with Python. * Free and Open Source Software, made with Python.
Installation Instructions
-------------------------
Official **documentation**, including `installation instructions`_, is
available at https://letsencrypt.readthedocs.org.
Links Links
----- -----