Skip to content

Commit 19c051a

Browse files
authored
Update README.md
1 parent ae2b92b commit 19c051a

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ Once pnpm is installed, you can navigate to the project directory and run the fo
5858

5959
3. Install dependencies: To install the necessary dependencies for the project, navigate to the project directory and run the following command:
6060
**`pnpm install`**
61-
4. Navigate to the **`src/data`** directory.
62-
5. Open the **`Profile.json`** file.
63-
6. Add your profile data: Copy the following JSON object, edit your details, and paste it in the middle of the **`Profile.json`** file. Make sure to follow the existing structure:
64-
65-
```json
61+
4. Navigate to the **`public/data`** folder in your project directory.
62+
5. Create a new JSON file named **`your_github_username.json`** (replace your_github_username with your actual GitHub username). Open the file you just created.
63+
7. Add the following JSON object, replacing the placeholder values with your own details:
64+
65+
```json
6666
{
6767
"name": "Your Name",
6868
"location": "Your Location",
@@ -77,11 +77,19 @@ Once pnpm is installed, you can navigate to the project directory and run the fo
7777
}
7878
},
7979
```
80-
81-
**`Note:`** Copy the above code, edit your details, and paste it in the middle (not at the top or bottom). It doesn't matter where you add your profile, it will appear randomly on the website.
82-
83-
7. Save the changes to the **`Profile.json`** file.
84-
8. Create a new branch: To create a new branch for your profile, run the following command:
80+
8. Save the **`your_github_username.json`** file.
81+
9. Navigate to the **`src`** folder in your project directory. Open the **`ProfilesList.json`** file.
82+
11. Add your JSON filename (your_github_username.json) to the array of filenames in the ProfileList.json file, like this:
83+
```json
84+
[
85+
"filename1.json",
86+
"filename2.json",
87+
"your_github_username.json"
88+
]
89+
90+
```
91+
12. Save the **`ProfileLists.json`** file.
92+
13. Create a new branch: To create a new branch for your profile, run the following command:
8593
**`git checkout -b add-profile`**
8694
9. Commit your changes: To save your changes to the branch, run the following command:
8795
**`git commit -m "add: <your-name>"`**
@@ -107,4 +115,4 @@ Contributions make the open source community such an amazing place to learn, ins
107115
## Support 🙏
108116

109117
Thank you for contributing to our open-source project! We appreciate your support 🚀 <br>
110-
Don't forget to leave a star
118+
Don't forget to leave a star

0 commit comments

Comments
 (0)