Skip to content

Commit 33c1e52

Browse files
authored
feat: a better README
1 parent b81c339 commit 33c1e52

1 file changed

Lines changed: 27 additions & 16 deletions

File tree

README.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,39 @@
11
# The Algorithms - JavaScript
22

3-
[![contributions welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square)](CONTRIBUTING.md)
4-
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat-square)](https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript)
3+
JavaScript Repository of TheAlgorithms, which implements various algorithms and data structures in JavaScript.
4+
5+
![JavasScript Banner](https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png)
6+
7+
[![Contributions Welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square)](CONTRIBUTING.md)
8+
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18&style=flat-square)](lgtm)
59
![Node CI](https://github.com/TheAlgorithms/Javascript/workflows/Node%20CI/badge.svg)
6-
![update_directory_md](https://github.com/TheAlgorithms/Javascript/workflows/update_directory_md/badge.svg)
7-
[![Discord chat](https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square)](https://discord.gg/c7MnfGFGa6)
8-
![](https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat-square)
9-
[![standard.js](https://img.shields.io/badge/code%20style-standardjs-%23f3df49)](https://standardjs.com/)
10+
[![Discord chat](https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square)](discord-server)
11+
![Repository Size](https://img.shields.io/github/repo-size/TheAlgorithms/Javascript.svg?label=Repo%20size&style=flat-square)
12+
[![standard.js](https://img.shields.io/badge/code%20style-standardjs-%23f3df49)](standard-js)
13+
14+
<hr>
1015

11-
## All algorithms implemented in JavaScript (for educational purposes only)
16+
**These are for demonstration purposes only. There are many implementations of sorts in the JavaScript standard library
17+
that are much better for performance and security reasons. We also do not provide any api stability guarantee.**
1218

13-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/TheAlgorithms/Javascript)
19+
Before contributing to this repository, make sure to read our [Contribution Guidelines](CONTRIBUTING.md). You can look
20+
at other [TheAlgorithms Repositories](repositories) or the [issues with a
21+
`help wanted` label](help-wanted) for inspiration regarding what to implement. Our maintainers will guide you through
22+
how to make your contribution properly.
1423

15-
These are for demonstration purposes only. There are many implementations of sorts in the JavaScript standard library
16-
that are much better for performance reasons.
24+
The names of the maintainers of this repository is listed in the [CODEOWNERS](.github/CODEOWNERS) file.
1725

18-
## Contribution Guidelines
26+
You can find a list of the algorithms currently in the repository in the [directory](DIRECTORY.md).
1927

20-
Read our [Contribution Guidelines](CONTRIBUTING.md) before you contribute.
28+
Explanations of many of the algorithms can be found in out [wiki](explanation).
2129

22-
## List of Algorithms
30+
<hr>
2331

24-
See our [directory](DIRECTORY.md).
32+
[lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript
33+
[discord-server]: https://discord.gg/c7MnfGFGa6
34+
[standard-js]: https://standardjs.com/
2535

26-
## Algorithm Explanation
36+
[repositories]: https://github.com/TheAlgorithms
37+
[help-wanted]: https://github.com/TheAlgorithms/JavaScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
38+
[explanation]: https://github.com/TheAlgorithms/JavaScript/wiki
2739

28-
See our [wiki](https://github.com/TheAlgorithms/Javascript/wiki).

0 commit comments

Comments
 (0)