Skip to content

Commit 82e9a7d

Browse files
authored
Merge pull request #56 from arguiot/all-contributors/add-pavsidhu-restyled
Restyle docs: add pavsidhu as a contributor
2 parents 4bff3d4 + 979b93b commit 82e9a7d

File tree

1 file changed

+36
-12
lines changed

1 file changed

+36
-12
lines changed

README.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A JavaScript testing framework for the real world
1010
<i>By the way, you can ⭐️ the project to support it 😊</i>
1111

1212
<div align="center">
13-
13+
1414
[![GitHub release](https://img.shields.io/github/release/arguiot/EyeJS.svg)](https://github.com/arguiot/EyeJS/releases)
1515
[![Build Status](https://travis-ci.org/arguiot/EyeJS.svg?branch=master)](https://travis-ci.org/arguiot/EyeJS)
1616
[![Github All Releases](https://img.shields.io/github/downloads/arguiot/EyeJS/total.svg)](https://github.com/arguiot/EyeJS/)
@@ -22,60 +22,81 @@ A JavaScript testing framework for the real world
2222

2323
## Getting Started
2424

25-
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).
25+
To use EyeJS, you'll need to download EyeJS via NPM, and create a `__test__`
26+
folder in your project folder, and put tests files in it. (NPM might require
27+
`sudo` on Mac).
28+
2629
```bash
2730
$ npm install -g eye.js
2831
```
32+
2933
## Run EyeJS
34+
3035
EyeJS comes with a CLI:
36+
3137
```bash
3238
$ eye
3339
```
40+
3441
## The full docs can be found [here](https://github.com/arguiot/EyeJS/wiki)
3542

3643
## Support
37-
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:
44+
45+
EyeJS is a project that required a lot of work and effort. You can show your
46+
appreciation by leaving a ⭐️. But you can also contribute in a 'financial' way
47+
by giving some XMRs (if you have no idea of what this is, look for Monero on
48+
Google) at this address:
49+
3850
```bash
3951
49qzWTyu4awZFpnVRUZHCQE8xz1bcoRkCQh1nrRsTHg3if6osQqVXRoFAyGYvhDR4pZ4w8WTKQDykYy5Z2Sj6i9TAj2fiBr
4052
```
4153

4254
## Contributing
4355

44-
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
56+
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of
57+
conduct, and the process for submitting pull requests to us.
4558

4659
#### Made something using the EyeJS?
4760

4861
Add the built with EyeJS badge to your `README.md`
4962

5063
[![Built with EyeJS](https://img.shields.io/badge/Built%20with-EyeJS-blue.svg)](https://img.shields.io/badge/Built%20with-EyeJS-blue.svg)
5164

52-
53-
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.
65+
Feel free to send me an email at [[email protected]](mailto:[email protected]),
66+
and I might add your site to an examples section I'm currently working on.
5467

5568
## Examples of projects using EyeJS
69+
5670
- [DisplayJS](https://display.js.org)
5771
- [Glottologist](https://glottologist.js.org)
5872
- [CrypTools Org](https://cryptools.github.io)
5973

6074
## Versioning
6175

62-
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/arguiot/EyeJS/tags).
76+
We use [SemVer](http://semver.org/) for versioning. For the versions available,
77+
see the [tags on this repository](https://github.com/arguiot/EyeJS/tags).
6378

6479
## Authors
6580

66-
- **Arthur Guiot** - *Initial work* - [@arguiot](https://github.com/arguiot)
81+
- **Arthur Guiot** - _Initial work_ - [@arguiot](https://github.com/arguiot)
6782

68-
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 😊.
83+
Also look at the list of
84+
[contributors](https://github.com/arguiot/EyeJS/contributors) who participated
85+
in this project. If you don't code but you have great ideas, don't hesitate to
86+
write your idea in the issue part. If your idea is accepted, I will add you to
87+
this list 😊.
6988

7089
## License
7190

72-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
91+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
92+
for details
7393

7494
Copyright &copy; 2017 Arthur Guiot All Rights Reserved.
7595

7696
## Contributors ✨
7797

78-
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
98+
Thanks goes to these wonderful people
99+
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
79100

80101
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
81102
<!-- prettier-ignore-start -->
@@ -89,6 +110,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
89110

90111
<!-- markdownlint-enable -->
91112
<!-- prettier-ignore-end -->
113+
92114
<!-- ALL-CONTRIBUTORS-LIST:END -->
93115

94-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
116+
This project follows the
117+
[all-contributors](https://github.com/all-contributors/all-contributors)
118+
specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)