feat: improve repository structure (#3)

raklaptudirm · nikhilkala · Panquesito7 · web-flow · commit 292ee000c398 · 2022-09-06T22:23:18.000-06:00
* Update README.md

* chore: add maintainer list

* Update README.md

Co-authored-by: David Leal &lt;halfpacho@gmail.com&gt;

* Update README.md

Co-authored-by: David Leal &lt;halfpacho@gmail.com&gt;

Co-authored-by: Nikhil Kala &lt;nikhilkala8@gmail.com&gt;
Co-authored-by: David Leal &lt;halfpacho@gmail.com&gt;
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @raklaptudirm
diff --git a/README.md b/README.md
@@ -1,2 +1,48 @@
-# TypeScript
+# The Algorithms - TypeScript
+
+<!-- Front Matter -->
 TypeScript Repository of TheAlgorithms, which implements various algorithms and data structures in TypeScript.
+
+<div align="center">
+
+  [![TypeScript Banner][banner]](DIRECTORY.md)
+
+  [![Contributions Welcome][welcome]](CONTRIBUTING.md)
+  [![Discord chat][chat]][discord-server]
+
+  
+</div>
+
+---
+
+<!-- Disclaimer -->
+
+<h4 align="center">
+  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.
+</h4>
+
+---
+
+<!-- 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 are listed in the
+[CODEOWNERS file](.github/CODEOWNERS).
+
+---
+
+<!-- Banner Image -->
+[banner]: https://user-images.githubusercontent.com/68542775/188368881-da2b9676-417a-4bbe-b8b7-20a497246f30.jpg
+
+<!-- Badge Links -->
+[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
+
+<!-- External Links -->
+[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
