You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://github.com/arguiot/EyeJS/)
@@ -22,60 +22,81 @@ A JavaScript testing framework for the real world
22
22
23
23
## Getting Started
24
24
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
+
26
29
```bash
27
30
$ npm install -g eye.js
28
31
```
32
+
29
33
## Run EyeJS
34
+
30
35
EyeJS comes with a CLI:
36
+
31
37
```bash
32
38
$ eye
33
39
```
40
+
34
41
## The full docs can be found [here](https://github.com/arguiot/EyeJS/wiki)
35
42
36
43
## 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
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.
45
58
46
59
#### Made something using the EyeJS?
47
60
48
61
Add the built with EyeJS badge to your `README.md`
49
62
50
63
[](https://img.shields.io/badge/Built%20with-EyeJS-blue.svg)
51
64
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.
and I might add your site to an examples section I'm currently working on.
54
67
55
68
## Examples of projects using EyeJS
69
+
56
70
-[DisplayJS](https://display.js.org)
57
71
-[Glottologist](https://glottologist.js.org)
58
72
-[CrypTools Org](https://cryptools.github.io)
59
73
60
74
## Versioning
61
75
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).
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 😊.
69
88
70
89
## License
71
90
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
0 commit comments