Skip to content

Commit 16424d9

Browse files
docs(readme): improve README.md for clarity, structure, and engagement (#405)
1 parent 2c645e2 commit 16424d9

File tree

1 file changed

+33
-9
lines changed

1 file changed

+33
-9
lines changed

README.md

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,39 @@
1-
# Accessible Web Dev
21

3-
This site is intended to be a resource for developers wanting to learn the basics about accessibility in a clear and easy to understand way. It is not intended to replace official documentation and guidelines but to provide a stepping stone to get started where official documentation is often difficult to interpret for new web developers.
2+
# [Accessible Web Dev](https://accessibleweb.dev/) 🌐
43

5-
![Screenshot of Accessible Web Dev homepage](/public/images/websiteScreenshot.png)
4+
Welcome to **Accessible Web Dev**, a resource designed to help web developers learn the fundamentals of accessibility in a practical, easy-to-understand way. This site is an **entry point** into the world of accessibility, complementing current standards by breaking down complex concepts. While it doesn't replace existing standards like the [WCAG standards](https://www.w3.org/WAI/standards-guidelines/wcag/), it offers a beginner-friendly pathway into accessibility for developers of all experience levels.
65

7-
## Contributing
6+
![Screenshot of Accessible Web Dev homepage showing a clean, accessible interface with key topics and resources.](/public/images/websiteScreenshot.png)
87

9-
- To report a bug, please raise a [bug report](https://github.com/AccessibleForAll/AccessibleWebDev/issues/new?assignees=&labels=&template=bug_report.md&title=)
10-
- To request a new feature, please raise an [issue](https://github.com/AccessibleForAll/AccessibleWebDev/issues/new?assignees=&labels=&template=feature_request.md&title=)
11-
- To make a contribution to documentation, translation, code or design please follow the [contributing guidelines](https://github.com/AccessibleForAll/AccessibleWebDev/blob/main/CONTRIBUTING.md)
8+
---
129

13-
## License
10+
## 🚀 Features
1411

15-
AccessibleWebDev is licensed under the MIT License - see [License](https://github.com/AccessibleForAll/AccessibleWebDev/blob/main/LICENSE)
12+
- **Beginner-Friendly Content**: Step-by-step guides to start your accessibility journey.
13+
- **Practical Examples**: Real-world implementations of accessibility best practices.
14+
- **Resources & Tools**: Discover accessibility checkers, ARIA guides, and more.
15+
- **Community-Driven**: Contributions from developers worldwide to keep the content relevant and up-to-date.
16+
17+
---
18+
19+
## 🤝 How to Contribute
20+
21+
We welcome and encourage contributions! There are multiple ways to help improve this project:
22+
23+
1. **Report Bugs:**
24+
If you encounter a bug, please raise a [Bug Report](https://github.com/AccessibleForAll/AccessibleWebDev/issues/new?assignees=&labels=&template=bug_report.md&title=).
25+
26+
2. **Request New Features:**
27+
Have ideas for new features? Submit an [Issue](https://github.com/AccessibleForAll/AccessibleWebDev/issues/new?assignees=&labels=&template=feature_request.md&title=).
28+
29+
3. **Contribute Code, Documentation, or Design:**
30+
We are always looking to improve! Please follow our [Contributing Guidelines](https://github.com/AccessibleForAll/AccessibleWebDev/blob/main/CONTRIBUTING.md) to submit code, translations, or design updates.
31+
32+
4. **Spread the Word:**
33+
Share the project with your peers to help promote accessibility across the web.
34+
35+
---
36+
37+
## 📄 License
38+
39+
Accessible Web Dev is licensed under the **MIT License**. See the full [License](https://github.com/AccessibleForAll/AccessibleWebDev/blob/main/LICENSE) for more details.

0 commit comments

Comments
 (0)