diff --git a/README.md b/README.md index 1205d33..db4632b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ -# wfetch +# Wfetch-cr -TODO: Write a description here +Wfetch-cr is a rewrite of one of my programs, wfetch (made in python) + +I made this version because I wanted to learn a new programming language and take advantage of the speed of crystal! + +This version of wfetch is semi-backwards compatible (config.toml will work! But not disp.toml...) ## Installation @@ -16,7 +20,7 @@ TODO: Write development instructions here ## Contributing -1. Fork it () +1. Fork it () 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`) @@ -24,4 +28,4 @@ TODO: Write development instructions here ## Contributors -- [koffeejava](https://github.com/your-github-user) - creator and maintainer +- [KoffeeJava](https://github.com/koffeejava) - creator and maintainer