Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kojix2 authored Dec 22, 2023
1 parent 265bae3 commit d9c6127
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,23 @@
# nt.cr

TODO: Write a description here
[![build](https://github.com/kojix2/nt.cr/actions/workflows/build.yml/badge.svg)](https://github.com/kojix2/nt.cr/actions/workflows/build.yml)

`nt` is a tool that runs your command and then sends a desktop notification.

## Installation

TODO: Write installation instructions here
[GitHub Releases](https://github.com/kojix2/nt.cr/releases)

## Usage

TODO: Write usage instructions here

## Development

TODO: Write development instructions here
```
nt <command>
```

## Contributing

1. Fork it (<https://github.com/your-github-user/nt.cr/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
Fork and pull requests are welcome!

## Contributors
## License

- [kojix2](https://github.com/your-github-user) - creator and maintainer
- MIT

0 comments on commit d9c6127

Please sign in to comment.