Browse Source

docs: fix README

Signed-off-by: Gyuho Lee <gyuhox@gmail.com>
Gyuho Lee 7 years ago
parent
commit
104b6a3424
2 changed files with 5 additions and 4 deletions
  1. 4 3
      docs/README.md
  2. 1 1
      docs/index.rst

+ 4 - 3
docs/README.md

@@ -1,9 +1,9 @@
 
 
 #### etcd Documentation
 #### etcd Documentation
 
 
-This is an official etcd documentation https://etcd.readthedocs.io/en/latest.
+This is official etcd documentation.
 
 
-Working in progress...
+Please visit https://etcd.readthedocs.io/en/latest for latest builds.
 
 
 #### Install and build
 #### Install and build
 
 
@@ -12,7 +12,8 @@ Working in progress...
 pip install sphinx sphinx-autobuild
 pip install sphinx sphinx-autobuild
 pip install sphinx_rtd_theme
 pip install sphinx_rtd_theme
 
 
+make help
 make html
 make html
 ```
 ```
 
 
-And open `_build/html/index.html` for preview.
+And open `_build/html/index.html` file for preview.

+ 1 - 1
docs/index.rst

@@ -2,7 +2,7 @@
 etcd Documentation
 etcd Documentation
 ==================
 ==================
 
 
-This is an official etcd documentation.
+This is official etcd documentation.
 
 
 Still working in progress...
 Still working in progress...