Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shyamtawli authored May 23, 2023
1 parent ae2b92b commit 19c051a
Showing 1 changed file with 19 additions and 11 deletions.
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ Once pnpm is installed, you can navigate to the project directory and run the fo

3. Install dependencies: To install the necessary dependencies for the project, navigate to the project directory and run the following command:
**`pnpm install`**
4. Navigate to the **`src/data`** directory.
5. Open the **`Profile.json`** file.
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:

```json
4. Navigate to the **`public/data`** folder in your project directory.
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.
7. Add the following JSON object, replacing the placeholder values with your own details:
```json
{
"name": "Your Name",
"location": "Your Location",
Expand All @@ -77,11 +77,19 @@ Once pnpm is installed, you can navigate to the project directory and run the fo
}
},
```

**`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.

7. Save the changes to the **`Profile.json`** file.
8. Create a new branch: To create a new branch for your profile, run the following command:
8. Save the **`your_github_username.json`** file.
9. Navigate to the **`src`** folder in your project directory. Open the **`ProfilesList.json`** file.
11. Add your JSON filename (your_github_username.json) to the array of filenames in the ProfileList.json file, like this:
```json
[
"filename1.json",
"filename2.json",
"your_github_username.json"
]

```
12. Save the **`ProfileLists.json`** file.
13. Create a new branch: To create a new branch for your profile, run the following command:
**`git checkout -b add-profile`**
9. Commit your changes: To save your changes to the branch, run the following command:
**`git commit -m "add: <your-name>"`**
Expand All @@ -107,4 +115,4 @@ Contributions make the open source community such an amazing place to learn, ins
## Support 🙏

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

1 comment on commit 19c051a

@vercel
Copy link

@vercel vercel bot commented on 19c051a May 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.