Skip to content

Commit bcccf30

Browse files
feat: Enhance README with badges, social links, and improved formatting
1 parent cad49b1 commit bcccf30

File tree

1 file changed

+29
-9
lines changed

1 file changed

+29
-9
lines changed

README.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
1-
# Optimism Docs
1+
![Optimism Logo](https://github.com/ethereum-optimism/docs/blob/main/public/logos/docs-header.png)
2+
3+
[![GitHub issues](https://img.shields.io/github/issues/ethereum-optimism/docs)](https://github.com/ethereum-optimism/docs/issues)
4+
[![GitHub forks](https://img.shields.io/github/forks/ethereum-optimism/docs)](https://github.com/ethereum-optimism/docs/network)
5+
[![GitHub stars](https://img.shields.io/github/stars/ethereum-optimism/docs)](https://github.com/ethereum-optimism/docs/stargazers)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/ethereum-optimism/optimism/blob/develop/LICENSE)
27

38
This repo houses the Optimism Docs located at [docs.optimism.io](https://docs.optimism.io/). All documentation-related updates and new content will be tracked and maintained in this repo.
49

5-
## Local Development
10+
## 🚀 Local Development
611

7-
How to [install pnpm](https://pnpm.io/installation)
12+
💡 How to [install pnpm](https://pnpm.io/installation)
813

9-
First, run `pnpm i` to install the dependencies.
14+
```sh
15+
pnpm i # Install dependencies
16+
```
1017

11-
Then, run `pnpm dev` to start the development server and visit localhost:3000.
18+
```sh
19+
pnpm dev # Start the development server
20+
```
21+
Visit `localhost:3000` to view the documentation locally.
1222

13-
## Contributions
23+
## 🛠 Contributions
1424

15-
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) page for specifics on how to write PRs, use the linter, run spellcheck, add dictionary terms, etc. You should also review the [Optimism Documentation Style Guide](/pages/connect/contribute/style-guide.mdx) for additional guidelines, especially if you are writing entirely brand new pages to the developer docs, as opposed to smaller edits and/or revisions.
25+
Please see the CONTRIBUTING.md page for specifics on how to write PRs, use the linter, run spellcheck, add dictionary terms, etc. You should also review the Optimism Documentation Style Guide for additional guidelines, especially if you are writing entirely brand new pages to the developer docs, as opposed to smaller edits and/or revisions.
1626

17-
## Project Board
27+
## 📌 Project Board
1828

1929
You can track documentation [issues](https://github.com/ethereum-optimism/docs/issues) or submit documentation [requests](https://github.com/ethereum-optimism/docs/issues/new/choose) directly from this repo.
2030

21-
## License
31+
## 📜 License
2232

2333
This project is licensed under the [MIT License](https://github.com/ethereum-optimism/optimism/blob/develop/LICENSE).
2434

35+
## 🌐 Connect with Us
36+
37+
[![X (Twitter)](https://img.shields.io/badge/Follow%20on%20X-000000?logo=x&logoColor=white&style=for-the-badge)](https://x.com/optimism)
38+
[![Discord](https://img.shields.io/badge/Discord-%237289DA.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/invite/optimism)
39+
[![GitHub](https://img.shields.io/badge/GitHub-%23181717.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/ethereum-optimism)
40+
[![Website](https://img.shields.io/badge/Website-%23FF0420.svg?style=for-the-badge&logo=google-chrome&logoColor=white)](https://www.optimism.io/)
41+
42+
💡 Stay connected, contribute, and help us build a better ecosystem!
43+
44+

0 commit comments

Comments
 (0)