Skip to content

Commit edd7076

Browse files
authored
merge: A better README (TheAlgorithms#1003)
* feat: a better README * chore: update repositories link * chore: fix broken links * chore: use gfm `<hr>` syntax Replaced <hr> with ---, which is GitHub Flavoured Markdown syntax. * chore: align everything to be centered * feat: use same style for all badges * chore: use shields.io badge instead of github * chore: reorder badges and add comments * chore: edit and format body * chore: add redirect links to all images * typo: JavasScript -> JavaScript
1 parent b81c339 commit edd7076

File tree

1 file changed

+50
-17
lines changed

1 file changed

+50
-17
lines changed

README.md

Lines changed: 50 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,61 @@
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)
5-
![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/)
3+
<!-- Front Matter -->
4+
JavaScript Repository of TheAlgorithms, which implements various algorithms and data structures in JavaScript.
105

11-
## All algorithms implemented in JavaScript (for educational purposes only)
6+
<div align="center">
127

13-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/TheAlgorithms/Javascript)
8+
[![JavaScript Banner][banner]](DIRECTORY.md)
149

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.
10+
[![Language grade: JavaScript][grade]][lgtm]
11+
[![Checks][checks]][actions]
12+
[![Contributions Welcome][welcome]](CONTRIBUTING.md)
13+
[![standard.js][standard-logo]][standard-js]
14+
[![Discord chat][chat]][discord-server]
1715

18-
## Contribution Guidelines
16+
17+
</div>
1918

20-
Read our [Contribution Guidelines](CONTRIBUTING.md) before you contribute.
19+
---
2120

22-
## List of Algorithms
21+
<!-- Disclaimer -->
2322

24-
See our [directory](DIRECTORY.md).
23+
<h4 align="center">
24+
These implementations are for demonstrative purposes only. Dedicated implementations of these algorithms and data
25+
structures are much better for performance and security reasons. We also do not provide any api stability guarantee.
26+
</h4>
2527

26-
## Algorithm Explanation
28+
---
29+
30+
<!-- Body -->
31+
32+
Before contributing to this repository, make sure to read our [Contribution Guidelines](CONTRIBUTING.md). You can look
33+
at other [TheAlgorithms Repositories][repositories] or the [issues with a "help wanted" label][help-wanted] for
34+
inspiration regarding what to implement. Our maintainers will guide you through how to make your contribution properly
35+
if you make any mistakes. The names of the maintainers of this repository is listed in the
36+
[CODEOWNERS file](.github/CODEOWNERS).
37+
38+
You can find a list of the algorithms currently in the repository in the [directory](DIRECTORY.md). Explanations of
39+
many of the algorithms can be found in the [wiki][explanation].
40+
41+
---
42+
43+
<!-- Banner Image -->
44+
[banner]: https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png
45+
46+
<!-- Badge Links -->
47+
[standard-logo]: https://img.shields.io/badge/code%20style-standardjs-%23f3df49
48+
[chat]: https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA
49+
[welcome]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3
50+
[checks]: https://img.shields.io/github/workflow/status/TheAlgorithms/JavaScript/Node%20CI?label=checks
51+
[grade]: https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18
52+
53+
<!-- External Links -->
54+
[standard-js]: https://standardjs.com/
55+
[discord-server]: https://discord.gg/c7MnfGFGa6
56+
[actions]: https://github.com/TheAlgorithms/JavaScript/actions
57+
[explanation]: https://github.com/TheAlgorithms/JavaScript/wiki
58+
[repositories]: https://github.com/orgs/TheAlgorithms/repositories
59+
[lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript
60+
[help-wanted]: https://github.com/TheAlgorithms/JavaScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
2761

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

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy