Skip to content

Commit

Permalink
Add install and use sections in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Speykious committed Apr 24, 2024
1 parent 8f143b3 commit 57d44c2
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ A very simple configurable key overlay written in Rust.

![Screenshot of OwOverlay](screenshot.png)

## How do I install?

If you have the Rust toolchain installed, you can use `cargo`:

```sh
cargo install owoverlay
```

Eventually, binaries will be released in this repository.

## How do I use it?

See [cowonfig.toml](/cowonfig.toml) for an example config.

Config documentation is coming soon!

## License

This project is licensed under the MIT license.

0 comments on commit 57d44c2

Please sign in to comment.