Skip to content

Commit 248071b

Browse files
committed
fix: improve formatting and clarity in README for better readability
1 parent 3e367a9 commit 248071b

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@
99

1010
### Environment Variables (Optional)
1111

12-
Some features of the application require environment variables. This configuration is optional and only needed if you plan to work with Hello World pages.
12+
Some features of the application require environment variables. This
13+
configuration is optional and only needed if you plan to work with Hello World
14+
pages.
1315

14-
Create a `.env` file at the root of the project using the provided `.env.example` as a template:
16+
Create a `.env` file at the root of the project using the provided
17+
`.env.example` as a template:
1518

1619
```bash
1720
cp .env.example .env
@@ -34,7 +37,8 @@ To obtain your `VITE_REOWN_PROJECT_ID`, follow these steps:
3437
- Project name
3538
- Description (optional)
3639
- Website URL (optional)
37-
5. Once the project is created, copy the "Project ID" displayed in the project details
40+
5. Once the project is created, copy the "Project ID" displayed in the project
41+
details
3842
6. Paste this ID in your `.env` file as the value for `VITE_REOWN_PROJECT_ID`
3943

4044
## πŸš€ Getting Started
@@ -55,7 +59,8 @@ Start the development server:
5559
npm run dev
5660
```
5761

58-
The documentation site will be available at `http://localhost:3000` (or the port shown in your terminal).
62+
The documentation site will be available at `http://localhost:3000` (or the port
63+
shown in your terminal).
5964

6065
### Building for Production
6166

@@ -67,7 +72,8 @@ npm run build
6772

6873
## 🀝 Contributing
6974

70-
We welcome contributions to improve the iExec documentation! Please follow these steps to contribute:
75+
We welcome contributions to improve the iExec documentation! Please follow these
76+
steps to contribute:
7177

7278
### 1. Fork the Repository
7379

@@ -78,12 +84,14 @@ Fork this repository and ensure you're working on the `main` branch:
7884
### 2. Set Up Your Development Environment
7985

8086
1. Clone your forked repository:
87+
8188
```bash
8289
git clone https://github.com/YOUR_USERNAME/documentation.git
8390
cd documentation
8491
```
8592

8693
2. Install dependencies:
94+
8795
```bash
8896
npm install
8997
```
@@ -96,6 +104,7 @@ Fork this repository and ensure you're working on the `main` branch:
96104
### 3. Make Your Changes
97105

98106
1. Create a new branch for your feature/fix:
107+
99108
```bash
100109
git checkout -b feature/your-feature-name
101110
```
@@ -106,12 +115,14 @@ Fork this repository and ensure you're working on the `main` branch:
106115
### 4. Submit Your Changes
107116

108117
1. Stage and commit your changes with a descriptive message:
118+
109119
```bash
110120
git add .
111121
git commit -m "Add: descriptive commit message"
112122
```
113123

114124
2. Push your changes to your forked repository:
125+
115126
```bash
116127
git push origin feature/your-feature-name
117128
```
@@ -120,17 +131,21 @@ Fork this repository and ensure you're working on the `main` branch:
120131

121132
### 5. Review Process
122133

123-
> **πŸ’‘ Tips:**
124-
> - You can open a draft pull request and mark it as "Ready for review" once you're satisfied with the preview
134+
> **πŸ’‘ Tips:**
135+
>
136+
> - You can open a draft pull request and mark it as "Ready for review" once
137+
> you're satisfied with the preview
125138
> - All pull requests are reviewed by our team before being merged
126139
> - Feel free to ask questions in the pull request if you need clarification
127140
128141
## πŸ“„ License
129142

130-
This project is part of the iExec ecosystem. Please refer to the main iExec repositories for licensing information.
143+
This project is part of the iExec ecosystem. Please refer to the main iExec
144+
repositories for licensing information.
131145

132146
## πŸ†˜ Support
133147

134148
- πŸ“– [Documentation](https://docs.iex.ec)
135149
- πŸ’¬ [Discord Community](https://discord.com/invite/pbt9m98wnU)
136-
- πŸ› [Issue Tracker](https://github.com/iExecBlockchainComputing/documentation/issues)
150+
- πŸ›
151+
[Issue Tracker](https://github.com/iExecBlockchainComputing/documentation/issues)

0 commit comments

Comments
Β (0)