Skip to content

Commit

Permalink
docs: Update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Shinyzenith <[email protected]>
  • Loading branch information
Shinyzenith committed Apr 7, 2024
1 parent bb6d2c0 commit 088df4e
Showing 1 changed file with 31 additions and 9 deletions.
40 changes: 31 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,34 @@
# Waysip
<p align=center>
<!-- <img src="https://git.sr.ht/~shinyzenith/wayshot/blob/main/docs/assets/wayshot.png" alt=wayshot width=60%> -->
<p align=center>A native, blazing-fast 🚀🚀🚀 area selection tool for wlroots based compositors such as sway and river.</p>

it is a crate like slurp, to select area on wayland, which support layershell.
<p align="center">
<a href="./LICENSE.md"><img src="https://img.shields.io/github/license/waycrate/wayshot?style=flat-square&logo=appveyor"></a>
<img src="https://img.shields.io/badge/cargo-v0.2.2-green?style=flat-square&logo=appveyor">
<img src="https://img.shields.io/github/issues/waycrate/waysip?style=flat-square&logo=appveyor">
<img src="https://img.shields.io/github/forks/waycrate/waysip?style=flat-square&logo=appveyor">
<img src="https://img.shields.io/github/stars/waycrate/waysip?style=flat-square&logo=appveyor">
<br>
<img src="https://repology.org/badge/vertical-allrepos/waysip.svg">
</p>
</p>

usage
# Some usage examples:

```rust
use libwaysip::{get_area, WaySipKind};
fn main() {
println!("{:?}", get_area(WaySipKind::Area));
}
```
TODO:

# Installation

## Compile time dependencies:
TODO:

## Compiling:

- `git clone https://github.com/waycrate/waysip && cd waysip`
- `cargo buid --release`
- `sudo mv ./target/release/waysip /usr/local/bin`

# Support:

1. https://matrix.to/#/#waycrate-tools:matrix.org
2. https://discord.gg/KKZRDYrRYW

0 comments on commit 088df4e

Please sign in to comment.