Cleanup (#5)

cariad · Oct 5, 2021 · c95fccd · c95fccd
1 parent 66d3826
commit c95fccd
Show file tree

Hide file tree

Showing 8 changed files with 172 additions and 187 deletions.
diff --git a/Pipfile b/Pipfile
@@ -6,7 +6,7 @@ name = "pypi"
 [packages]
 
 [dev-packages]
-ansiscape = "==1.0.0a1"
+ansiscape = "*"
 black = "==21.9b0"
 flake8 = "*"
 isort = "*"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ Full documentation is published at [naughtty.readthedocs.io](https://naughtty.re
 pip install naughtty
 ```
 
-**NaughTTY** requires the host operating system to support forking and pseudo-terminals. GNU/Linux is good. At the time of writing, Windows is not. No guarantees are made for any operating system.
+**NaughTTY** requires the host operating system to support forking and pseudo-terminals. GNU/Linux is good. At the time of writing, Windows is not.
 
 ## Basic CLI usage
 

diff --git a/docs/about.md b/docs/about.md
diff --git a/docs/index.md b/docs/index.md
@@ -31,3 +31,15 @@ And that's where NaughTTY comes in!
 ## The Solution: NaughTTY
 
 NaughTTY is a CLI tool and Python package for running commands in a pseudo-terminal and capturing their output. This allows you to fool a command into emitting escape codes during redirection and piping when it normally wouldn't.
+
+## Feedback
+
+Please raise bugs, request features and ask questions at [github.com/cariad/naughtty/issues](https://github.com/cariad/naughtty/issues).
+
+Mention if you're a [sponsor](https://github.com/sponsors/cariad) to ensure I respond as a priority. Thank you!
+
+## Project
+
+The source for `naughtty` is available at [github.com/cariad/naughtty](https://github.com/cariad/naughtty) under the MIT licence.
+
+And, **hello!** I'm [Cariad Eccleston](https://cariad.io) and I'm an independent/freelance software engineer. If my work has value to you, please consider [sponsoring](https://github.com/sponsors/cariad/).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,7 +5,6 @@ nav:
   - install.md
   - cli.md
   - python.md
-  - about.md
 site_name: NaughTTY
 theme:
   name: readthedocs
diff --git a/naughtty/cli.py b/naughtty/cli.py
@@ -31,7 +31,7 @@ def make_response(cli_args: Optional[List[str]] = None) -> str:
         # command's arguments:
         add_help=False,
         description="Executes a shell command in a pseudo-terminal and prints its output to stdout.",
-        epilog="For example: naughtty pipenv --help > out.txt",
+        epilog="Made with love by Cariad Eccleston: https://github.com/cariad/naughtty",
     )
 
     parser.add_argument("command", help="command", nargs="*")

diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -53,7 +53,7 @@ def test_make_response__for_execution__with_help() -> None:
 def test_make_response__for_help() -> None:
     response = make_response(["--help"])
     assert response.startswith("usage: ")
-    assert response.endswith("naughtty pipenv --help > out.txt\n")
+    assert response.endswith("Eccleston: https://github.com/cariad/naughtty\n")
     assert "naughtty" in response