Skip to content

Commit b5fbc25

Browse files
author
Krum Motsov
committed
Update readme.md
1 parent fb59857 commit b5fbc25

File tree

1 file changed

+25
-75
lines changed

1 file changed

+25
-75
lines changed

readme.md

Lines changed: 25 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,38 @@
1-
## About
1+
[![Testspace](http://www.testspace.com/public/img/testspace_logo.png)](http://www.testspace.com)
2+
***
23

3-
![](https://travis-ci.org/mgechev/javascript-algorithms.svg?branch=master)
4+
## JavaScript/Jasmine sample for demonstrating Testspace
45

5-
This repository contains JavaScript implementations of different famous Computer Science algorithms.
6+
Sample demonstrates techniques for using Testspace with Javascript code and the [Jasmine test framework]() together with [Istanbul code coverage tool]() and [Gulp JS build system].
67

7-
API reference with usage examples available <a href="https://mgechev.github.io/javascript-algorithms/" target="_blank">here</a>.
8+
[![Build Status](https://travis-ci.org/testspace-samples/javascript.jasmine.svg?branch=master)](https://travis-ci.org/testspace-samples/php.phpunit)
9+
[![Space Health](https://samples.testspace.com/projects/89/spaces/298/badge)](https://samples.testspace.com/projects/89/spaces/298 "Test Cases")
10+
[![Space Metric](https://samples.testspace.com/projects/89/spaces/298/metrics/198/badge)](https://samples.testspace.com/projects/89/spaces/298/metrics#metric-198 "Branch/Condition Coverage")
11+
[![Space Metric](https://samples.testspace.com/projects/89/spaces/298/metrics/197/badge)](https://samples.testspace.com/projects/89/spaces/298/metrics#metric-197 "Function/Method Coverage")
12+
[![Space Metric](https://samples.testspace.com/projects/89/spaces/298/metrics/191/badge)](https://samples.testspace.com/projects/89/spaces/298/metrics#metric-191 "Line/Statement Coverage")
813

9-
*Note: not all algorithms are well tested so bugs are quite possible.*
1014

11-
## Development
15+
***
1216

13-
**To install all dev dependencies**
17+
In order to run this sample you will need a host workstation with installed npm.
1418

15-
Call:
16-
17-
```bash
18-
npm install
19-
```
20-
21-
**To setup repository with documentation**
22-
23-
- Go to the parent directory of the `javascript-algorithms` folder and call:
24-
25-
```bash
26-
git clone https://github.com/mgechev/javascript-algorithms.git javascript-algorithms-docs
27-
```
28-
29-
- Go to the `javascript-algorithms-docs` folder and change current branch to `gh-pages`:
30-
31-
```bash
32-
git checkout gh-pages
33-
```
34-
35-
Now you can see `index.html` file in this folder and open it in your browser.
36-
37-
**To update .html files with documentation**
38-
39-
Go to the `javascript-algorithms` folder and call:
40-
41-
```bash
42-
gulp jsdoc
43-
```
44-
45-
and all files in `javascript-algorithms-docs` folder will be updated.
46-
47-
**To run tests**
48-
49-
Call:
50-
51-
```bash
52-
gulp test
53-
```
54-
55-
and all `*.spec.js` files will be executed.
56-
57-
## Contributions
58-
59-
Fork the repo and make requred changes. After that push your changes in branch, which is named according to the changes you did.
60-
Initiate the PR.
61-
62-
Make sure you're editor makes validations according to the `.jshintrc` in the root directory of the repository.
63-
64-
Before pushing to the repository run:
65-
66-
```bash
19+
<pre>
20+
npm install -g gulp
6721
gulp build
68-
```
69-
70-
If the build is not successful fix your code in order the tests and jshint validation to run successfully and after that create a pull request.
71-
72-
## Contributors
22+
</pre>
7323

74-
[<img alt="mgechev" src="https://avatars.githubusercontent.com/u/455023?v=3&s=117" width="117">](https://github.com/mgechev) |[<img alt="AndriiHeonia" src="https://avatars.githubusercontent.com/u/773648?v=3&s=117" width="117">](https://github.com/AndriiHeonia) |[<img alt="Jakehp" src="https://avatars.githubusercontent.com/u/1854569?v=3&s=117" width="117">](https://github.com/Jakehp) |[<img alt="pvoznenko" src="https://avatars.githubusercontent.com/u/1098414?v=3&s=117" width="117">](https://github.com/pvoznenko) |[<img alt="FilipeFalcaoBatista" src="https://avatars.githubusercontent.com/u/9125631?v=3&s=117" width="117">](https://github.com/FilipeFalcaoBatista) |[<img alt="lekkas" src="https://avatars.githubusercontent.com/u/5211478?v=3&s=117" width="117">](https://github.com/lekkas) |
75-
:---: |:---: |:---: |:---: |:---: |:---: |
76-
[mgechev](https://github.com/mgechev) |[AndriiHeonia](https://github.com/AndriiHeonia) |[Jakehp](https://github.com/Jakehp) |[pvoznenko](https://github.com/pvoznenko) |[FilipeFalcaoBatista](https://github.com/FilipeFalcaoBatista) |[lekkas](https://github.com/lekkas) |
24+
Publishing results example:
7725

78-
[<img alt="deniskyashif" src="https://avatars.githubusercontent.com/u/5999271?v=3&s=117" width="117">](https://github.com/deniskyashif) |[<img alt="infusion" src="https://avatars.githubusercontent.com/u/197742?v=3&s=117" width="117">](https://github.com/infusion) |[<img alt="designeng" src="https://avatars.githubusercontent.com/u/2807469?v=3&s=117" width="117">](https://github.com/designeng) |[<img alt="Microfed" src="https://avatars.githubusercontent.com/u/613179?v=3&s=117" width="117">](https://github.com/Microfed) |[<img alt="ysharplanguage" src="https://avatars.githubusercontent.com/u/1055314?v=3&s=117" width="117">](https://github.com/ysharplanguage) |[<img alt="contra" src="https://avatars.githubusercontent.com/u/425716?v=3&s=117" width="117">](https://github.com/contra) |
79-
:---: |:---: |:---: |:---: |:---: |:---: |
80-
[deniskyashif](https://github.com/deniskyashif) |[infusion](https://github.com/infusion) |[designeng](https://github.com/designeng) |[Microfed](https://github.com/Microfed) |[ysharplanguage](https://github.com/ysharplanguage) |[contra](https://github.com/contra) |
26+
<pre>
27+
testspace publish [Tests]test/reports/junitresults.xml test/reports/coverage/clover.xml
28+
</pre>
8129

82-
[<img alt="fanixk" src="https://avatars.githubusercontent.com/u/921156?v=3&s=117" width="117">](https://github.com/fanixk) |
83-
:---: |
84-
[fanixk](https://github.com/fanixk) |
30+
Checkout the [Space](https://samples.testspace.com/projects/javascript/spaces/jasmine).
8531

86-
## License
32+
***
8733

88-
The code in this repository is distributed under the terms of the MIT license.
34+
To fork this example using Travis requires:
35+
- Create an account at www.testspace.com
36+
- Travis Environment Variables:
37+
- `TESTSPACE_USER_TOKEN` set to the `value` defined as your [Access token](http://help.testspace.com/using-your-organization:user-settings).
38+
- `TESTSPACE_URL` set to `my-org-name.testspace.com/my-project/my-space`. Refer [here](http://help.testspace.com/reference:runner-reference#config) for more details. This example uses `samples.testspace.com/javascript/jasmine`.

0 commit comments

Comments
 (0)