From 86afe71df252e9d945598fcc9e1a672d717fa2ef Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Mon, 5 Sep 2022 11:20:17 +0530 Subject: [PATCH 1/4] Update README.md --- README.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f0369e5..14c2dd82 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,48 @@ -# TypeScript +# The Algorithms - TypeScript + + TypeScript Repository of TheAlgorithms, which implements various algorithms and data structures in TypeScript. + +
+ + [![TypeScript Banner][banner]](DIRECTORY.md) + + [![Contributions Welcome][welcome]](CONTRIBUTING.md) + [![Discord chat][chat]][discord-server] + + +
+ +--- + + + +

+ 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 guarantee for api stability. +

+ +--- + + + +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). + +--- + + +[banner]: https://user-images.githubusercontent.com/68542775/188368881-da2b9676-417a-4bbe-b8b7-20a497246f30.jpg + + +[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 + + +[discord-server]: https://discord.gg/c7MnfGFGa6 +[actions]: https://github.com/TheAlgorithms/TypeScript/actions +[repositories]: https://github.com/orgs/TheAlgorithms/repositories +[help-wanted]: https://github.com/TheAlgorithms/TypeScript/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22 From 001382be222a14602197bc5e43692bb378cf4237 Mon Sep 17 00:00:00 2001 From: Rak Laptudirm Date: Mon, 5 Sep 2022 11:22:29 +0530 Subject: [PATCH 2/4] chore: add maintainer list --- .github/CODEOWNERS | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..4fa26ece --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @raklaptudirm From 84d46a90432ba53b86283bcce2d78915b37d81d4 Mon Sep 17 00:00:00 2001 From: Nikhil Kala Date: Tue, 6 Sep 2022 22:21:50 -0600 Subject: [PATCH 3/4] Update README.md Co-authored-by: David Leal --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 14c2dd82..a0dc0820 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,8 @@ TypeScript Repository of TheAlgorithms, which implements various algorithms and

- 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 guarantee for api stability. + These implementations are for demonstrative/educational purposes only. Dedicated implementations of these algorithms and data + structures are much better for performance and security reasons. We also do not provide any guarantee for API stability.

--- From 430a6325934f2ec743fc70cce9ad1e1814b89455 Mon Sep 17 00:00:00 2001 From: Nikhil Kala Date: Tue, 6 Sep 2022 22:22:29 -0600 Subject: [PATCH 4/4] Update README.md Co-authored-by: David Leal --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a0dc0820..92bfcccf 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ TypeScript Repository of TheAlgorithms, which implements various algorithms and 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 +if you make any mistakes. The names of the maintainers of this repository are listed in the [CODEOWNERS file](.github/CODEOWNERS). ---