Merge pull request #30 from iluxonchik/hotfix/update-readme

Fix formatting issues in README
iluxonchik · Mar 16, 2019 · 84bca57 · 84bca57
2 parents 51217ae + 8f82cdf
commit 84bca57
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# RFC-Bibtex
+# RFC BibTex
 
 A command line tool that creates `BibTex` entries for IETF `RFC`s and `Internet Drafts`.
 It can read the list of `RFC`s and `Internet Drafts` to parse from various sources:
@@ -27,7 +27,7 @@ should work fine.
 **Requirements**:
 
 * `Python 3.x`
-* internet connection
+* Internet connection
 
 ## Testing
 
@@ -49,27 +49,28 @@ from the project root.
 
 This tool automates the requests to the `https://datatracker.ietf.org/doc/<id>/<version>/bibtex/` and `https://datatracker.ietf.org/doc/<id>/bibtex/` endpoints.
 
-  usage: rfcbibtex [-h] [-f FILE_NAME] [-o FILE_NAME]
-                  [inline_args [inline_args ...]]
-
-  Generate BibTex entries for IETF RFCs and Internet Drafts. The list of IDs can
-  be read from a file (including .tex and .aux) or directly from command-line
-  arguments.
-
-  positional arguments:
-    inline_args           list of RFC and/or Internet Draft IDs, in any order.
-
-  optional arguments:
-    -h, --help            show this help message and exit
-    -f FILE_NAME, --file FILE_NAME
-                          read list of RFC and/or Internet Draft IDs from a
-                          file. Supported file formats are the following: .tex,
-                          .aux and .txt (one ID per line). If a file with any
-                          other extension is provided, the tool attempts to read
-                          it as a .txt file, containing one ID per line.
-    -o FILE_NAME, --output FILE_NAME
-                          output the resulting BibTex to a file
-
+```
+usage: rfcbibtex [-h] [-f FILE_NAME] [-o FILE_NAME]
+                [inline_args [inline_args ...]]
+
+Generate BibTex entries for IETF RFCs and Internet Drafts. The list of IDs can
+be read from a file (including .tex and .aux) or directly from command-line
+arguments.
+
+positional arguments:
+inline_args           list of RFC and/or Internet Draft IDs, in any order.
+
+optional arguments:
+-h, --help            show this help message and exit
+-f FILE_NAME, --file FILE_NAME
+                        read list of RFC and/or Internet Draft IDs from a
+                        file. Supported file formats are the following: .tex,
+                        .aux and .txt (one ID per line). If a file with any
+                        other extension is provided, the tool attempts to read
+                        it as a .txt file, containing one ID per line.
+-o FILE_NAME, --output FILE_NAME
+                        output the resulting BibTex to a file
+```
 
 ## Identifier Format
 

diff --git a/setup.py b/setup.py
@@ -6,14 +6,14 @@
 setuptools.setup(
     name='rfcbibtex',
     packages = ['rfc_bibtex'],
-    version='0.3.1',
+    version='0.3.2',
     author='Illya Gerasymchuk',
     author_email='[email protected]',
     description='Generate Bibtex entries for IETF RFCs and Internet Drafts.',
     long_description=long_description,
     long_description_content_type='text/markdown',
     url = 'https://github.com/iluxonchik/rfc-bibtex/',
-    download_url = 'https://github.com/iluxonchik/rfc-bibtex/archive/0.3.1.tar.gz',
+    download_url = 'https://github.com/iluxonchik/rfc-bibtex/archive/0.3.2.tar.gz',
     license = 'MIT',
     classifiers=(
         'Programming Language :: Python :: 3.6',