-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #60 from arguiot/all-contributors/add-nblackburn-r…
…estyled Restyle docs: add nblackburn as a contributor
- Loading branch information
Showing
1 changed file
with
36 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ A JavaScript testing framework for the real world | |
| <i>By the way, you can ⭐️ the project to support it 😊</i> | ||
|
|
||
| <div align="center"> | ||
|
|
||
| [](https://github.com/arguiot/EyeJS/releases) | ||
| [](https://travis-ci.org/arguiot/EyeJS) | ||
| [](https://github.com/arguiot/EyeJS/) | ||
|
|
@@ -22,60 +22,81 @@ 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? | ||
|
|
||
| Add the built with EyeJS badge to your `README.md` | ||
|
|
||
| [](https://img.shields.io/badge/Built%20with-EyeJS-blue.svg) | ||
|
|
||
|
|
||
| Feel free to send me an email at [[email protected]](mailto:[email protected]), and I might add your site to an examples section I'm currently working on. | ||
| Feel free to send me an email at [[email protected]](mailto:[email protected]), | ||
| 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)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
|
|
@@ -89,6 +110,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d | |
|
|
||
| <!-- markdownlint-enable --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! | ||
| This project follows the | ||
| [all-contributors](https://github.com/all-contributors/all-contributors) | ||
| specification. Contributions of any kind welcome! | ||