-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
A better README
#1003
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
A better README
#1003
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
33c1e52
feat: a better README
raklaptudirm 8aa0e88
chore: update repositories link
raklaptudirm 0afeeae
chore: fix broken links
raklaptudirm 1cef474
chore: use gfm `<hr>` syntax
raklaptudirm 8db0632
chore: align everything to be centered
raklaptudirm 221225d
feat: use same style for all badges
raklaptudirm 5ebf8c6
chore: use shields.io badge instead of github
raklaptudirm 8970110
chore: reorder badges and add comments
raklaptudirm ba14c40
chore: edit and format body
raklaptudirm 9413b03
chore: add redirect links to all images
raklaptudirm b085d03
typo: JavasScript -> JavaScript
raklaptudirm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,61 @@ | ||
# The Algorithms - JavaScript | ||
|
||
[](CONTRIBUTING.md) | ||
[](https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript) | ||
 | ||
 | ||
[](https://discord.gg/c7MnfGFGa6) | ||
 | ||
[](https://standardjs.com/) | ||
<!-- Front Matter --> | ||
JavaScript Repository of TheAlgorithms, which implements various algorithms and data structures in JavaScript. | ||
|
||
## All algorithms implemented in JavaScript (for educational purposes only) | ||
<div align="center"> | ||
|
||
[](https://gitpod.io/#https://github.com/TheAlgorithms/Javascript) | ||
[![JavasScript Banner][banner]](DIRECTORY.md) | ||
|
||
These are for demonstration purposes only. There are many implementations of sorts in the JavaScript standard library | ||
that are much better for performance reasons. | ||
[![Language grade: JavaScript][grade]][lgtm] | ||
[![Checks][checks]][actions] | ||
[![Contributions Welcome][welcome]](CONTRIBUTING.md) | ||
[![standard.js][standard-logo]][standard-js] | ||
[![Discord chat][chat]][discord-server] | ||
|
||
## Contribution Guidelines | ||
|
||
</div> | ||
|
||
Read our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. | ||
--- | ||
|
||
## List of Algorithms | ||
<!-- Disclaimer --> | ||
|
||
See our [directory](DIRECTORY.md). | ||
<h4 align="center"> | ||
These implementations are for demonstrative purposes only. Dedicated implementations of these algorithms and data | ||
structures are much better for performance and security reasons. We also do not provide any api stability guarantee. | ||
</h4> | ||
|
||
## Algorithm Explanation | ||
--- | ||
|
||
<!-- Body --> | ||
|
||
Before contributing to this repository, make sure to read our [Contribution Guidelines](CONTRIBUTING.md). You can look | ||
at other [TheAlgorithms Repositories][repositories] or the [issues with a "help wanted" label][help-wanted] for | ||
inspiration regarding what to implement. Our maintainers will guide you through how to make your contribution properly | ||
if you make any mistakes. The names of the maintainers of this repository is listed in the | ||
[CODEOWNERS file](.github/CODEOWNERS). | ||
|
||
You can find a list of the algorithms currently in the repository in the [directory](DIRECTORY.md). Explanations of | ||
many of the algorithms can be found in the [wiki][explanation]. | ||
|
||
--- | ||
|
||
<!-- Banner Image --> | ||
[banner]: https://user-images.githubusercontent.com/68542775/167072911-dc31eac8-6885-4a05-9c25-279ecce22a79.png | ||
|
||
<!-- Badge Links --> | ||
[standard-logo]: https://img.shields.io/badge/code%20style-standardjs-%23f3df49 | ||
[chat]: https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA | ||
[welcome]: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3 | ||
[checks]: https://img.shields.io/github/workflow/status/TheAlgorithms/JavaScript/Node%20CI?label=checks | ||
[grade]: https://img.shields.io/lgtm/grade/javascript/g/TheAlgorithms/Javascript.svg?logo=lgtm&logoWidth=18 | ||
|
||
<!-- External Links --> | ||
[standard-js]: https://standardjs.com/ | ||
[discord-server]: https://discord.gg/c7MnfGFGa6 | ||
[actions]: https://github.com/TheAlgorithms/JavaScript/actions | ||
[explanation]: https://github.com/TheAlgorithms/JavaScript/wiki | ||
[repositories]: https://github.com/orgs/TheAlgorithms/repositories | ||
[lgtm]: https://lgtm.com/projects/g/TheAlgorithms/Javascript/context:javascript | ||
[help-wanted]: https://github.com/TheAlgorithms/JavaScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 | ||
|
||
See our [wiki](https://github.com/TheAlgorithms/Javascript/wiki). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.