fixed ellipses in documentation

README.md

@@ -1,5 +1,7 @@
 # Description
 
+Provides certain tools to be run on the overlay directory. See individual commands help for details.
+
 This is a small collection of tools to help automate some tasks related to Gentoo overlay maintenance.
 
 It can:
@@ -26,7 +28,7 @@ $ eselect repository enable nitratesky && emerge -a1 TODO
 ## Sample usage
 
 The overlay directory is at `/srv/overlay`. To generate a README with the badges, create a skeleton template
-(like the one in repo) and run:
+(like [the one in repo](https://github.com/raw/VTimofeenko/overlay-maintain-tools/master/docs/templates/skeleton.jinja2)) and run:
 
 ```
 $ overlay_maintain_tools --overlay-dir /srv/overlay mkreadme --skeleton-file /path/to/readme.template
@@ -61,13 +63,13 @@ These options can be specified for any `COMMAND` except for  `create-config` whi
 
 **Commands**:
 
-* `check-remote-versions`: Prints a report on the packages in the...
-* `mkreadme`: Generates a README for an overlay using a...
+* `check-remote-versions`: Prints report on the versions of packages.
+* `mkreadme`: Creates a README for an overlay.
 
 # Commands
 ## `overlay_maintain_tools mkreadme`
 
-Generates a README for an overlay using a template. The generated README can utilize data on packages
+Creates a README for an overlay. The generated README can utilize data on packages
 available in the overlay and their versions. For sample template, see the documentation.
 
 **Usage**:
@@ -85,7 +87,7 @@ $ overlay_maintain_tools mkreadme [OPTIONS]
 
 ## `overlay_maintain_tools check-remote-versions`
 
-Prints a report on the packages in the overlay and their versions available upstream.
+Prints report on the versions of packages. Checks versions available upstream.
 Pulls the data from remotes specified inside <upstream> tag in metadata.xml
 
 **Usage**:

docs/templates/skeleton.jinja2

@@ -27,7 +27,7 @@ $ eselect repository enable nitratesky && emerge -a1 TODO
 ## Sample usage
 
 The overlay directory is at `/srv/overlay`. To generate a README with the badges, create a skeleton template
-(like the one in repo) and run:
+(like [the one in repo](https://github.com/raw/VTimofeenko/overlay-maintain-tools/master/docs/templates/skeleton.jinja2)) and run:
 
 ```
 $ overlay_maintain_tools --overlay-dir /srv/overlay mkreadme --skeleton-file /path/to/readme.template

overlay_maintain_tools/main.py

@@ -47,7 +47,7 @@ def mkreadme(
         help="Where to save the resulting README. If not supplied - print to stdout.",
     ),
 ):
-    """Generates a README for an overlay using a template. The generated README can utilize data on packages
+    """Creates a README for an overlay. The generated README can utilize data on packages
     available in the overlay and their versions. For sample template, see the documentation."""
     template = setup_template(skeleton_template=skeleton_file, search_path=template_dir)
     text = render_template(packages_stash=ctx.obj.pkg_cache, template=template)
@@ -77,7 +77,7 @@ def check_remote_versions(
         True, "--color", help="Enable/disable color in output", show_default=False
     ),
 ):
-    """Prints a report on the packages in the overlay and their versions available upstream.
+    """Prints report on the versions of packages. Checks versions available upstream.
     Pulls the data from remotes specified inside <upstream> tag in metadata.xml"""
     pkgs_with_versions = process_pkgs(
         packages_stash=ctx.obj.pkg_cache, worker_count=ctx.obj.worker_count