Skip to content

Commit

Permalink
Update docu
Browse files Browse the repository at this point in the history
  • Loading branch information
dynobo committed Oct 18, 2020
1 parent c79b58e commit 121ea2e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,16 @@

## Usage

The tool can be started by `python -m keyhint` or simply `keyhint`. But as the **keyhint** displays hints based on the currently active window, you probably want to configure a **global hotkey** to trigger it on demand.
- Install: `pip install keyhint`
- Execute: `keyhint`
- Recommendation: Configure a **global hotkey** to start `keyhint` on demand.

Based on the **process name** and **window title** of the active window, different sets of hints are displayed.

_Screenshots of some hints:_

![General Firefox Shortcuts](assets/demo.gif)

## Installation

`pip install keyhint`

## Configuration

### Look & Behavior
Expand Down
9 changes: 5 additions & 4 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ bumpversion patch

## Submit to pypi

1. Build: `python setup.py sdist bdist_wheel`
2. Upload to testpypi: `twine upload --repository testpypi dist/*`
3. Test package: `twine upload --repository testpypi dist/*`
4. Upload to pypi: `twine upload --repository pypi dist/*`
1. Clean `rm -rf ./dist && rm -rf ./build`
2. Build: `python setup.py sdist bdist_wheel`
3. Upload to testpypi: `twine upload --repository testpypi dist/*`
4. Test package: `pip install -i https://test.pypi.org/simple/ keyhint==0.1.x`
5. Upload to pypi: `twine upload --repository pypi dist/*`

0 comments on commit 121ea2e

Please sign in to comment.