Skip to content

Commit d87dc54

Browse files
committed
Update docs
1 parent a4d0a19 commit d87dc54

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

readme.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
This repository contains JavaScript implementations of different famous Computer Science algorithms.
66

7-
API reference with usage examples available <a href="https://mgechev.github.io/javascript-algorithms/" target="_blank">here</a>.
7+
API reference with usage examples available
8+
<a href="https://mgechev.github.io/javascript-algorithms/" target="_blank">here</a>.
89

910
## Development
1011

@@ -18,13 +19,13 @@ npm install
1819

1920
**To setup repository with documentation**
2021

21-
- Go to the parent directory of the `javascript-algorithms` folder and call:
22+
* Go to the parent directory of the `javascript-algorithms` folder and call:
2223

2324
```bash
2425
git clone https://github.com/mgechev/javascript-algorithms.git javascript-algorithms-docs
2526
```
2627

27-
- Go to the `javascript-algorithms-docs` folder and change current branch to `gh-pages`:
28+
* Go to the `javascript-algorithms-docs` folder and change current branch to `gh-pages`:
2829

2930
```bash
3031
git checkout gh-pages
@@ -54,8 +55,8 @@ and all `*.spec.js` files will be executed.
5455

5556
## Contributions
5657

57-
Fork the repo and make required changes. After that push your changes in branch, which is named according to the changes you did.
58-
Initiate the PR.
58+
Fork the repo and make required changes. After that push your changes in branch, which is named according to the changes
59+
you did. Initiate the PR.
5960

6061
Make sure you're editor makes validations according to the `.jshintrc` in the root directory of the repository.
6162

@@ -65,29 +66,30 @@ Before pushing to the repository run:
6566
gulp build
6667
```
6768

68-
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.
69+
If the build is not successful fix your code in order the tests and jshint validation to run successfully and after that
70+
create a pull request.
6971

7072
## Contributors
7173

72-
[<img alt="mgechev" src="https://avatars1.githubusercontent.com/u/455023?v=4&s=117" width="117">](https://github.com/mgechev) |[<img alt="AndriiHeonia" src="https://avatars1.githubusercontent.com/u/773648?v=4&s=117" width="117">](https://github.com/AndriiHeonia) |[<img alt="Jakehp" src="https://avatars1.githubusercontent.com/u/1854569?v=4&s=117" width="117">](https://github.com/Jakehp) |[<img alt="lygstate" src="https://avatars3.githubusercontent.com/u/121040?v=4&s=117" width="117">](https://github.com/lygstate) |[<img alt="mik-laj" src="https://avatars1.githubusercontent.com/u/12058428?v=4&s=117" width="117">](https://github.com/mik-laj) |[<img alt="krzysztof-grzybek" src="https://avatars0.githubusercontent.com/u/6236664?v=4&s=117" width="117">](https://github.com/krzysztof-grzybek) |
73-
:---: |:---: |:---: |:---: |:---: |:---: |
74-
[mgechev](https://github.com/mgechev) |[AndriiHeonia](https://github.com/AndriiHeonia) |[Jakehp](https://github.com/Jakehp) |[lygstate](https://github.com/lygstate) |[mik-laj](https://github.com/mik-laj) |[krzysztof-grzybek](https://github.com/krzysztof-grzybek) |
74+
| [<img alt="mgechev" src="https://avatars1.githubusercontent.com/u/455023?v=4&s=117" width="117">](https://github.com/mgechev) | [<img alt="AndriiHeonia" src="https://avatars1.githubusercontent.com/u/773648?v=4&s=117" width="117">](https://github.com/AndriiHeonia) | [<img alt="Jakehp" src="https://avatars1.githubusercontent.com/u/1854569?v=4&s=117" width="117">](https://github.com/Jakehp) | [<img alt="lygstate" src="https://avatars3.githubusercontent.com/u/121040?v=4&s=117" width="117">](https://github.com/lygstate) | [<img alt="mik-laj" src="https://avatars1.githubusercontent.com/u/12058428?v=4&s=117" width="117">](https://github.com/mik-laj) | [<img alt="krzysztof-grzybek" src="https://avatars0.githubusercontent.com/u/6236664?v=4&s=117" width="117">](https://github.com/krzysztof-grzybek) |
75+
| :---------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------: |
76+
| [mgechev](https://github.com/mgechev) | [AndriiHeonia](https://github.com/AndriiHeonia) | [Jakehp](https://github.com/Jakehp) | [lygstate](https://github.com/lygstate) | [mik-laj](https://github.com/mik-laj) | [krzysztof-grzybek](https://github.com/krzysztof-grzybek) |
7577

76-
[<img alt="pvoznenko" src="https://avatars3.githubusercontent.com/u/1098414?v=4&s=117" width="117">](https://github.com/pvoznenko) |[<img alt="jettcalleja" src="https://avatars0.githubusercontent.com/u/6356258?v=4&s=117" width="117">](https://github.com/jettcalleja) |[<img alt="filipefalcaos" src="https://avatars2.githubusercontent.com/u/9125631?v=4&s=117" width="117">](https://github.com/filipefalcaos) |[<img alt="kdamball" src="https://avatars3.githubusercontent.com/u/3318312?v=4&s=117" width="117">](https://github.com/kdamball) |[<img alt="lekkas" src="https://avatars3.githubusercontent.com/u/5211478?v=4&s=117" width="117">](https://github.com/lekkas) |[<img alt="infusion" src="https://avatars3.githubusercontent.com/u/197742?v=4&s=117" width="117">](https://github.com/infusion) |
77-
:---: |:---: |:---: |:---: |:---: |:---: |
78-
[pvoznenko](https://github.com/pvoznenko) |[jettcalleja](https://github.com/jettcalleja) |[filipefalcaos](https://github.com/filipefalcaos) |[kdamball](https://github.com/kdamball) |[lekkas](https://github.com/lekkas) |[infusion](https://github.com/infusion) |
78+
| [<img alt="pvoznenko" src="https://avatars3.githubusercontent.com/u/1098414?v=4&s=117" width="117">](https://github.com/pvoznenko) | [<img alt="jettcalleja" src="https://avatars0.githubusercontent.com/u/6356258?v=4&s=117" width="117">](https://github.com/jettcalleja) | [<img alt="filipefalcaos" src="https://avatars2.githubusercontent.com/u/9125631?v=4&s=117" width="117">](https://github.com/filipefalcaos) | [<img alt="kdamball" src="https://avatars3.githubusercontent.com/u/3318312?v=4&s=117" width="117">](https://github.com/kdamball) | [<img alt="lekkas" src="https://avatars3.githubusercontent.com/u/5211478?v=4&s=117" width="117">](https://github.com/lekkas) | [<img alt="infusion" src="https://avatars3.githubusercontent.com/u/197742?v=4&s=117" width="117">](https://github.com/infusion) |
79+
| :--------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: |
80+
| [pvoznenko](https://github.com/pvoznenko) | [jettcalleja](https://github.com/jettcalleja) | [filipefalcaos](https://github.com/filipefalcaos) | [kdamball](https://github.com/kdamball) | [lekkas](https://github.com/lekkas) | [infusion](https://github.com/infusion) |
7981

80-
[<img alt="deniskyashif" src="https://avatars2.githubusercontent.com/u/5999271?v=4&s=117" width="117">](https://github.com/deniskyashif) |[<img alt="designeng" src="https://avatars0.githubusercontent.com/u/2807469?v=4&s=117" width="117">](https://github.com/designeng) |[<img alt="pkerpedjiev" src="https://avatars3.githubusercontent.com/u/2143629?v=4&s=117" width="117">](https://github.com/pkerpedjiev) |[<img alt="Xuefeng-Zhu" src="https://avatars0.githubusercontent.com/u/5875315?v=4&s=117" width="117">](https://github.com/Xuefeng-Zhu) |[<img alt="Microfed" src="https://avatars1.githubusercontent.com/u/613179?v=4&s=117" width="117">](https://github.com/Microfed) |[<img alt="alexjoverm" src="https://avatars3.githubusercontent.com/u/5701162?v=4&s=117" width="117">](https://github.com/alexjoverm) |
81-
:---: |:---: |:---: |:---: |:---: |:---: |
82-
[deniskyashif](https://github.com/deniskyashif) |[designeng](https://github.com/designeng) |[pkerpedjiev](https://github.com/pkerpedjiev) |[Xuefeng-Zhu](https://github.com/Xuefeng-Zhu) |[Microfed](https://github.com/Microfed) |[alexjoverm](https://github.com/alexjoverm) |
82+
| [<img alt="deniskyashif" src="https://avatars2.githubusercontent.com/u/5999271?v=4&s=117" width="117">](https://github.com/deniskyashif) | [<img alt="designeng" src="https://avatars0.githubusercontent.com/u/2807469?v=4&s=117" width="117">](https://github.com/designeng) | [<img alt="pkerpedjiev" src="https://avatars3.githubusercontent.com/u/2143629?v=4&s=117" width="117">](https://github.com/pkerpedjiev) | [<img alt="Xuefeng-Zhu" src="https://avatars0.githubusercontent.com/u/5875315?v=4&s=117" width="117">](https://github.com/Xuefeng-Zhu) | [<img alt="Microfed" src="https://avatars1.githubusercontent.com/u/613179?v=4&s=117" width="117">](https://github.com/Microfed) | [<img alt="alexjoverm" src="https://avatars3.githubusercontent.com/u/5701162?v=4&s=117" width="117">](https://github.com/alexjoverm) |
83+
| :--------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------: |
84+
| [deniskyashif](https://github.com/deniskyashif) | [designeng](https://github.com/designeng) | [pkerpedjiev](https://github.com/pkerpedjiev) | [Xuefeng-Zhu](https://github.com/Xuefeng-Zhu) | [Microfed](https://github.com/Microfed) | [alexjoverm](https://github.com/alexjoverm) |
8385

84-
[<img alt="amilajack" src="https://avatars1.githubusercontent.com/u/6374832?v=4&s=117" width="117">](https://github.com/amilajack) |[<img alt="shaunak1111" src="https://avatars3.githubusercontent.com/u/1323960?v=4&s=117" width="117">](https://github.com/shaunak1111) |[<img alt="contra" src="https://avatars0.githubusercontent.com/u/425716?v=4&s=117" width="117">](https://github.com/contra) |[<img alt="liesislukas" src="https://avatars3.githubusercontent.com/u/2733862?v=4&s=117" width="117">](https://github.com/liesislukas) |[<img alt="millerrach" src="https://avatars2.githubusercontent.com/u/12432794?v=4&s=117" width="117">](https://github.com/millerrach) |[<img alt="fanixk" src="https://avatars2.githubusercontent.com/u/921156?v=4&s=117" width="117">](https://github.com/fanixk) |
85-
:---: |:---: |:---: |:---: |:---: |:---: |
86-
[amilajack](https://github.com/amilajack) |[shaunak1111](https://github.com/shaunak1111) |[contra](https://github.com/contra) |[liesislukas](https://github.com/liesislukas) |[millerrach](https://github.com/millerrach) |[fanixk](https://github.com/fanixk) |
86+
| [<img alt="amilajack" src="https://avatars1.githubusercontent.com/u/6374832?v=4&s=117" width="117">](https://github.com/amilajack) | [<img alt="shaunak1111" src="https://avatars3.githubusercontent.com/u/1323960?v=4&s=117" width="117">](https://github.com/shaunak1111) | [<img alt="contra" src="https://avatars0.githubusercontent.com/u/425716?v=4&s=117" width="117">](https://github.com/contra) | [<img alt="liesislukas" src="https://avatars3.githubusercontent.com/u/2733862?v=4&s=117" width="117">](https://github.com/liesislukas) | [<img alt="millerrach" src="https://avatars2.githubusercontent.com/u/12432794?v=4&s=117" width="117">](https://github.com/millerrach) | [<img alt="fanixk" src="https://avatars2.githubusercontent.com/u/921156?v=4&s=117" width="117">](https://github.com/fanixk) |
87+
| :--------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------: |
88+
| [amilajack](https://github.com/amilajack) | [shaunak1111](https://github.com/shaunak1111) | [contra](https://github.com/contra) | [liesislukas](https://github.com/liesislukas) | [millerrach](https://github.com/millerrach) | [fanixk](https://github.com/fanixk) |
8789

88-
[<img alt="ysharplanguage" src="https://avatars0.githubusercontent.com/u/1055314?v=4&s=117" width="117">](https://github.com/ysharplanguage) |
89-
:---: |
90-
[ysharplanguage](https://github.com/ysharplanguage) |
90+
| [<img alt="ysharplanguage" src="https://avatars0.githubusercontent.com/u/1055314?v=4&s=117" width="117">](https://github.com/ysharplanguage) |
91+
| :------------------------------------------------------------------------------------------------------------------------------------------: |
92+
| [ysharplanguage](https://github.com/ysharplanguage) |
9193

9294
## License
9395

0 commit comments

Comments
 (0)