diff --git a/.all-contributorsrc b/.all-contributorsrc index c3bf17b..7b77608 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -13,6 +13,15 @@ "contributions": [ "code" ] + }, + { + "login": "hankandre", + "name": "Hank Andre", + "avatar_url": "https://avatars1.githubusercontent.com/u/14790223?v=4", + "profile": "https://hankandre.com", + "contributions": [ + "content" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index 11140a6..3f68446 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

EyeJS

-[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)

@@ -10,7 +10,7 @@ A JavaScript testing framework for the real world By the way, you can ⭐️ the project to support it 😊

- + [![GitHub release](https://img.shields.io/github/release/arguiot/EyeJS.svg)](https://github.com/arguiot/EyeJS/releases) [![Build Status](https://travis-ci.org/arguiot/EyeJS.svg?branch=master)](https://travis-ci.org/arguiot/EyeJS) [![Github All Releases](https://img.shields.io/github/downloads/arguiot/EyeJS/total.svg)](https://github.com/arguiot/EyeJS/) @@ -22,26 +22,39 @@ A JavaScript testing framework for the real world ## Getting Started -To use EyeJS, you'll need to download EyeJS via NPM, and create a `__test__` folder in your project folder, and put tests files in it. (NPM might require `sudo` on Mac). +To use EyeJS, you'll need to download EyeJS via NPM, and create a `__test__` +folder in your project folder, and put tests files in it. (NPM might require +`sudo` on Mac). + ```bash $ npm install -g eye.js ``` + ## Run EyeJS + EyeJS comes with a CLI: + ```bash $ eye ``` + ## The full docs can be found [here](https://github.com/arguiot/EyeJS/wiki) ## Support -EyeJS is a project that required a lot of work and effort. You can show your appreciation by leaving a ⭐️. But you can also contribute in a 'financial' way by giving some XMRs (if you have no idea of what this is, look for Monero on Google) at this address: + +EyeJS is a project that required a lot of work and effort. You can show your +appreciation by leaving a ⭐️. But you can also contribute in a 'financial' way +by giving some XMRs (if you have no idea of what this is, look for Monero on +Google) at this address: + ```bash 49qzWTyu4awZFpnVRUZHCQE8xz1bcoRkCQh1nrRsTHg3if6osQqVXRoFAyGYvhDR4pZ4w8WTKQDykYy5Z2Sj6i9TAj2fiBr ``` ## Contributing -Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. +Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of +conduct, and the process for submitting pull requests to us. #### Made something using the EyeJS? @@ -49,33 +62,41 @@ Add the built with EyeJS badge to your `README.md` [![Built with EyeJS](https://img.shields.io/badge/Built%20with-EyeJS-blue.svg)](https://img.shields.io/badge/Built%20with-EyeJS-blue.svg) - -Feel free to send me an email at [arguiot@gmail.com](mailto:arguiot@gmail.com), and I might add your site to an examples section I'm currently working on. +Feel free to send me an email at [arguiot@gmail.com](mailto:arguiot@gmail.com), +and I might add your site to an examples section I'm currently working on. ## Examples of projects using EyeJS + - [DisplayJS](https://display.js.org) - [Glottologist](https://glottologist.js.org) - [CrypTools Org](https://cryptools.github.io) ## Versioning -We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/arguiot/EyeJS/tags). +We use [SemVer](http://semver.org/) for versioning. For the versions available, +see the [tags on this repository](https://github.com/arguiot/EyeJS/tags). ## Authors -- **Arthur Guiot** - *Initial work* - [@arguiot](https://github.com/arguiot) +- **Arthur Guiot** - _Initial work_ - [@arguiot](https://github.com/arguiot) -Also look at the list of [contributors](https://github.com/arguiot/EyeJS/contributors) who participated in this project. If you don't code but you have great ideas, don't hesitate to write your idea in the issue part. If your idea is accepted, I will add you to this list 😊. +Also look at the list of +[contributors](https://github.com/arguiot/EyeJS/contributors) who participated +in this project. If you don't code but you have great ideas, don't hesitate to +write your idea in the issue part. If your idea is accepted, I will add you to +this list 😊. ## License -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file +for details Copyright © 2017 Arthur Guiot All Rights Reserved. ## Contributors ✨ -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): +Thanks goes to these wonderful people +([emoji key](https://allcontributors.org/docs/en/emoji-key)): @@ -83,11 +104,15 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d +

Arthur Guiot
💻
Hank Andre
🖋
+ -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file +This project follows the +[all-contributors](https://github.com/all-contributors/all-contributors) +specification. Contributions of any kind welcome!