Update the documentation, increment version

lpenz · Mar 31, 2024 · 49a4ab3 · 49a4ab3
1 parent 79b4b8c
commit 49a4ab3
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -12,7 +12,7 @@ jobs:
     with:
       docs: false
       coveralls: true
-      publish_pypi: false
+      publish_pypi: true
       publish_github_release: true
     secrets:
       PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
diff --git a/README.md b/README.md
@@ -6,7 +6,10 @@
 
 # pthugefileviewer
 
-A console regular expression editor based on python's [prompt-toolkit].
+*pthugefileviewer* is a control for [prompt-toolkit] that can display
+huge files. It does so by mmap'ing the file and only reading the lines
+shown in the screen. It avoids any operation that would require
+reading the whole file, like counting the lines.
 
 
 ## Installation

diff --git a/setup.cfg b/setup.cfg
@@ -1,7 +1,7 @@
 [metadata]
 name = pthugefileviewer
-version = 0.1.0
-description = Console regular expression editor
+version = 0.1.1
+description = Huge file viewer control for prompt-toolkit
 license = MIT
 license_files = LICENSE
 long_description = file: README.md