Committing changes

README.md

@@ -1,6 +1,6 @@
 # logger
 
-TODO: Write a description here
+This is a logging library that utilizes crystal macros for appending codebase metadata (Class & Calling function) into the log string for easier debugging
 
 ## Installation
 
@@ -9,7 +9,7 @@ TODO: Write a description here
    ```yaml
    dependencies:
      logger:
-       github: your-github-user/logger
+       git: https://git.arcanium.tech/tristan/logger
    ```
 
 2. Run `shards install`
@@ -20,20 +20,7 @@ TODO: Write a description here
 require "logger"
 ```
 
-TODO: Write usage instructions here
-
-## Development
-
-TODO: Write development instructions here
-
-## Contributing
-
-1. Fork it (<https://github.com/your-github-user/logger/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
 
 ## Contributors
 
-- [Tristan Ancelet](https://github.com/your-github-user) - creator and maintainer
+- [Tristan Ancelet](https://git.arcanium.tech/tristan) - creator and maintainer