Update readme with badges 🌆

bmwant · Apr 17, 2022 · f4cc7b6 · f4cc7b6
1 parent 68a033f
commit f4cc7b6
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,20 @@
 ## hapless
 
+![Checks](https://github.com/bmwant/hapless/actions/workflows/tests.yml/badge.svg)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 ### Installation
 
 ```bash
 $ pip install hapless
+
+# or to make sure proper pip is used for the given python executable
 $ python -m pip install hapless
+```
 
+Install into user-specific directory in case of any permissions-related issues.
+
+```bash
 $ pip install --user hapless
 $ python -m pip install --user hapless
 ```

diff --git a/USAGE.md b/USAGE.md
@@ -15,6 +15,15 @@ $ hap run python ./examples/fast.py
 
 ### Checking status
 
+* Show summary for all haps
+
+```bash
+$ hap
+# or
+$ hap status  # equivalent
+$ hap show  # same as above
+```
+
 * Check status of the specific hap
 
 ```bash