From ee0919b77227a82ea82321068a30b1d1776eb2d0 Mon Sep 17 00:00:00 2001
From: Calum Andrew Morrell <calum@drulum.com>
Date: Wed, 4 Sep 2024 18:54:10 +0100
Subject: [PATCH] updated README.md

---
 README.md      | 18 ++++++++++++++++++
 pyproject.toml |  2 +-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2ca8788..a523ba8 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,21 @@
 This is intended to become a simple set of tools I use on a regular basis when developing a cli based app.
 
 You almost certainly don't want to use this. There are probably hundreds of alternatives on PyPi already - each one notably better than my own.
+
+Regardless, if you're determined to cause yourself pain, what does this library do? So far there's only one little function which exists out of sheer laziness on my part. It clears the terminal window and is platform independent.
+
+```python
+from dg_clt import screen
+
+screen.clear()
+```
+
+The entire code to provide that function is as follows:
+
+```python
+import os
+
+clear = lambda: os.system('cls' if os.name == 'nt' else 'clear')
+```
+
+I can just never recall the line off-hand when I need it.
diff --git a/pyproject.toml b/pyproject.toml
index b3e287d..7b608c8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dg-clt"
-version = "0.1.6"
+version = "0.1.7"
 description = "The Dazed Gerbil's Command Line Tools"
 authors = ["Calum Andrew Morrell <calum@drulum.com>"]
 readme = "README.md"