Skip to content

Commit 7ab064f

Browse files
docs: improve README clarity and formatting
1 parent 8106aea commit 7ab064f

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

โ€ŽREADME.mdโ€Ž

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22
<!-- Title: -->
33
<a href="https://github.com/TheAlgorithms/">
4-
<img src="https://raw.githubusercontent.com/TheAlgorithms/website/1cd824df116b27029f17c2d1b42d81731f28a920/public/logo.svg" height="100">
4+
<img src="https://raw.githubusercontent.com/TheAlgorithms/website/1cd824df116b27029f17c2d1b42d81731f28a920/public/logo.svg" height="100" alt="The Algorithms Logo">
55
</a>
66
<h1><a href="https://github.com/TheAlgorithms/">The Algorithms</a> - Python</h1>
77

@@ -13,7 +13,7 @@
1313
<a href="https://github.com/TheAlgorithms/Python/blob/master/CONTRIBUTING.md">
1414
<img src="https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square" height="20" alt="Contributions Welcome">
1515
</a>
16-
<img src="https://img.shields.io/github/repo-size/TheAlgorithms/Python.svg?label=Repo%20size&style=flat-square" height="20">
16+
<img src="https://img.shields.io/github/repo-size/TheAlgorithms/Python.svg?label=Repo%20size&style=flat-square" height="20" alt="Repository size">
1717
<a href="https://the-algorithms.com/discord">
1818
<img src="https://img.shields.io/discord/808045925556682782.svg?logo=discord&colorB=7289DA&style=flat-square" height="20" alt="Discord chat">
1919
</a>
@@ -27,26 +27,32 @@
2727
<img src="https://img.shields.io/github/actions/workflow/status/TheAlgorithms/Python/build.yml?branch=master&label=CI&logo=github&style=flat-square" height="20" alt="GitHub Workflow Status">
2828
</a>
2929
<a href="https://github.com/pre-commit/pre-commit">
30-
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" height="20" alt="pre-commit">
30+
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" height="20" alt="pre-commit enabled">
3131
</a>
3232
<a href="https://docs.astral.sh/ruff/formatter/">
33-
<img src="https://img.shields.io/static/v1?label=code%20style&message=ruff&color=black&style=flat-square" height="20" alt="code style: black">
33+
<img src="https://img.shields.io/static/v1?label=code%20style&message=ruff&color=black&style=flat-square" height="20" alt="code style: ruff">
3434
</a>
3535

3636
<!-- Short description: -->
37-
<h3>All algorithms implemented in Python - for education ๐Ÿ“š</h3>
37+
<h3>All algorithms implemented in Python โ€” for education ๐Ÿ“š</h3>
3838
</div>
3939

40-
Implementations are for learning purposes only. They may be less efficient than the implementations in the Python standard library. Use them at your discretion.
40+
This repository contains educational implementations of common algorithms and data structures in **Python**.
41+
42+
> These implementations are intended for learning. They may be less efficient than Pythonโ€™s built-in modules or standard library solutions. Use them at your discretion.
4143
4244
## ๐Ÿš€ Getting Started
4345

44-
๐Ÿ“‹ Read through our [Contribution Guidelines](CONTRIBUTING.md) before you contribute.
46+
Before contributing, please read our **[Contribution Guidelines](CONTRIBUTING.md)**.
4547

4648
## ๐ŸŒ Community Channels
4749

48-
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!
50+
Join the community on:
51+
- **[Discord](https://the-algorithms.com/discord)**
52+
- **[Gitter](https://gitter.im/TheAlgorithms/community)**
53+
54+
These channels are a great place to ask questions, get feedback, and collaborate with other contributors.
4955

5056
## ๐Ÿ“œ List of Algorithms
5157

52-
See our [directory](DIRECTORY.md) for easier navigation and a better overview of the project.
58+
For an overview of the repository structure, see **[DIRECTORY.md](DIRECTORY.md)**.

0 commit comments

Comments
ย (0)