Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
steveruizok committed Mar 12, 2021
1 parent f891202 commit a7724ee
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 3,868 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# 0.3.6

- Fixes bug with perfect-freehand.
- Fixes bug with cursor.
- Improves cursor hiding.

# 0.3.5

- Not sure, really.
Expand Down
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,16 @@ This app is in active development! **More soon.**

## Usage

With the app open, hover your cursor into the lower left corner of the screen to activate the controls. Click a color or tool to capture the cursor and begin drawing. Press `Escape` to release the cursor.
When open, the app sits on top of your screen as a transparent always-on-top window. When activated, your cursor will interact with the app. When not activated, your cursor will pass through to the windows beneath it.

- To view the app's toolbar, move your cursor into the lower left corner of your screen.
- To **activate** the app, select a color or tool. You can now begin drawing.
- To **deactivate** the app (and release your cursor), press `Escape`.

## Keyboard Shortcuts

- `Command + Option + Z` to activate the app.
- `Escape` to deactivate the app.
- `E` for ellipse tool.
- `R` for rectangle tool.
- `A` for arrow tool.
Expand All @@ -22,9 +28,28 @@ With the app open, hover your cursor into the lower left corner of the screen to
- `Command + F` to toggle fading.
- `Command + Z` to undo.
- `Command + Shift + Z` to redo.
- Release pointer with `Escape`.
- Clear screen and release pointer with `Command + Shift + E`.

You can also activate the app at any time by pressing `Command + Option + Z`.

## Tips and Tricks

- Double click the drawing tool to toggle between ink-style drawing and solid drawing.

## Roadmap

A loose idea of the features planned for development.

- [] Alert user to deactivate shortcut on first activation.
- [] In-app updates.
- [] Preferences menu.
- [] Customize global shortcut.
- [] Customize sizes.
- [] Customize colors.
- [] Customize background color (e.g. chroma key).
- [] Customize toolbar location (e.g. left, right, bottom, top).
- [] Add as menu icon instead of dock icon.

## Developing

This is an Electron app. If you're set up to do web dev then you'll be able to easily build the app from source. Clone this repo and run `yarn install` and `yarn dev` or `yarn build` just like you would with a regular web project.
Loading

0 comments on commit a7724ee

Please sign in to comment.