ietf

commit 3ed33279df26b5ccb186987aab32d89e6eae1352
parent 225941dfb717bcc398b7d469fa8d089707e31db9
Author: cy6erlion <dev@merely.tech>
Date:   Tue, 29 Dec 2020 19:19:33 +0200

add install instructions

Diffstat:
M
README.md
 | 
23
++++++++++++++++-------

1 file changed, 16 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-``` text▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
+``` text
 ██▄██ ▄▄█▄ ▄█ ▄▄
 ██ ▄█ ▄▄██ ██ ▄█
 █▄▄▄█▄▄▄██▄██▄██
@@ -6,12 +6,12 @@
 ```
 
 ``` bash
-$ ietf 0.1.0
-	
-A program to read IETF RFCs in the terminal.
+$ ietf -h
 
-USAGE:
+ietf 0.1.0
+A program to read RFCs in the terminal.
 
+USAGE:
 	ietf [OPTIONS] [SUBCOMMAND]
 	
 FLAGS:
@@ -20,10 +20,10 @@ FLAGS:
 			
 OPTIONS:
 	-n, --number <serial>    RFC Serial Number
-
+				
 SUBCOMMANDS:
 	help      Prints this message or the help of the given subcommand(s)
-	update    Update RFC Index
+	update    Update RFC Index						
 ```						
 
 ## Features
@@ -35,6 +35,15 @@ SUBCOMMANDS:
 		
 ## Guide
 
+### Installing
+
+You can install it with rust's package manager 
+[cargo](https://github.com/rust-lang/cargo) like this:
+
+``` bash
+ $ cargo install ietf
+```
+
 ### Running	
 To run simply type the following command in the shell to start the RFC
 browser: