Create README.md

saber13812002 · Feb 5, 2019 · a92b1fc · a92b1fc
1 parent e4dc975
commit a92b1fc
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,29 @@
+# Chuck Norris Jokes
+
+Create chuck norris jokes in your next PHP project.
+
+## Installation
+
+Require the package using composer:
+
+```bash
+composer require mpociot/chuck-norris-jokes
+```
+
+## Usage
+
+```php
+use Mpociot\ChuckNorrisJokes\JokeFactory;
+
+$jokes = new JokeFactory();
+
+$joke = $jokes->getRandomJoke();
+```
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+[MIT](./LICENSE.md)