diff --git a/README.md b/README.md index 182d36a8d905..4fd79672f5b0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,9 @@
-

The Algorithms - Python

- - Gitpod Ready-to-Code @@ -20,8 +17,6 @@ Gitter chat - -
GitHub Workflow Status @@ -32,21 +27,37 @@ code style: black - - -

All algorithms implemented in Python - for education πŸ“š

+

✨ All algorithms implemented in Python - for education πŸ“šβœ¨

+**Note** +
Implementations are for learning purposes only. They may be less efficient than the implementations in the Python standard library. Use them at your discretion. - -## πŸš€ Getting Started - -πŸ“‹ Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. - -## 🌐 Community Channels - -We are on [Discord](https://the-algorithms.com/discord) and [Gitter](https://gitter.im/TheAlgorithms/community)! Community channels are a great way for you to ask questions and get help. Please join us! - -## πŸ“œ List of Algorithms - -See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project. +

+## Getting Started +- πŸ“‹ Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute. + +

+ +## πŸ›  Usage Example + +Want to get started quickly? Follow these steps! +

+### 1. Clone the repository +
+
+### 2. Run tests +If tests are available, you can run them using: + +*Be sure to adjust the command if your test framework or folder structure is different.* +
+
+### 3. Use an algorithm in Python +Here’s how you might use the median finder: + +
+
+
+--- + + Enjoy learning and contributing to open source algorithms!