Update readme
This commit is contained in:
parent
26959020b7
commit
131b92b381
20
README.md
20
README.md
|
@ -1,22 +1,22 @@
|
||||||
# visor
|
# visor
|
||||||
|
|
||||||
TODO: Write a description here
|
Alternative frontend for YouTube
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
TODO: Write installation instructions here
|
```bash
|
||||||
|
pacman -Syu shards crystal
|
||||||
|
crystal deps
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
```bash
|
||||||
TODO: Write usage instructions here
|
crystal run src/visor.cr
|
||||||
|
```
|
||||||
## Development
|
|
||||||
|
|
||||||
TODO: Write development instructions here
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
1. Fork it ( https://github.com/[your-github-name]/visor/fork )
|
1. Fork it ( https://github.com/omarroth/visor/fork )
|
||||||
2. Create your feature branch (git checkout -b my-new-feature)
|
2. Create your feature branch (git checkout -b my-new-feature)
|
||||||
3. Commit your changes (git commit -am 'Add some feature')
|
3. Commit your changes (git commit -am 'Add some feature')
|
||||||
4. Push to the branch (git push origin my-new-feature)
|
4. Push to the branch (git push origin my-new-feature)
|
||||||
|
@ -24,4 +24,4 @@ TODO: Write development instructions here
|
||||||
|
|
||||||
## Contributors
|
## Contributors
|
||||||
|
|
||||||
- [[your-github-name]](https://github.com/[your-github-name]) Omar Roth - creator, maintainer
|
- [omarroth](https://github.com/omarroth) - creator, maintainer
|
||||||
|
|
Loading…
Reference in a new issue