Skip to content
This repository was archived by the owner on Jul 28, 2024. It is now read-only.

Commit 2d54b9a

Browse files
Improve README.md (#671)
* Updating the README! * Improve `README.md` * Updating the README! Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent c930b31 commit 2d54b9a

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
1-
# Awesome Github Profiles
1+
# Awesome GitHub profiles
22

33
![.github/workflows/main.yml](https://github.com/EddieJaoudeCommunity/awesome-github-profiles/workflows/.github/workflows/main.yml/badge.svg)
44

5-
List of GitHub profiles that have awesome customisation, that you can use for inspiration.
5+
List of GitHub profiles that have awesome customisation, that you can use for inspiration.\
6+
Feel free to submit a pull request with your suggestions of awesome GitHub profiles.
67

7-
Feel free to submit a pull request with your suggestions of awesome github profiles.
8+
## How can I add my GitHub profile?
89

9-
## To add your github profile
10-
11-
1. Create an issue, with the title as your name, and in the description put a screenshot of the customised GitHub profile page (copy the generated image url, this will be needed in the next step)
10+
1. Create an issue, with the title as your name, and in the description put a screenshot of the customised GitHub profile page (copy the generated image URL, this will be needed in the next step)
1211

1312
2. Fork the project
1413

15-
3. In `data.json` add your own object to the end of the file, your entry should be similar to this example:
14+
3. In the `data.json` file, add your own object to the end of the file. Your entry should be similar to this example:
1615

17-
```typescript
16+
```json
1817
{
1918
"name": "Eddie Jaoude",
2019
"githubUsername": "eddiejaoude",
@@ -23,13 +22,13 @@ Feel free to submit a pull request with your suggestions of awesome github profi
2322
}
2423
```
2524

26-
**Note** : Please do not edit anything below `<!--START_SECTION:data-section-->` in `README.MD` our [GitHub Action](https://github.com/EddieJaoudeCommunity/gh-action-community) will make the necessary changes for you.
25+
**Note** : Please do not edit anything below `<!--START_SECTION:data-section-->` in `README.md`. Our [GitHub Action](https://github.com/EddieJaoudeCommunity/gh-action-community) will make the necessary changes for you.
2726

2827
4. Create a Pull Request to add the changes to this Repository. Please change the title to `add your-username` and in the description add `resolve #issueNumber`
2928

30-
Any questions let us know!
29+
Any questions, let us know!
3130

32-
**Join the conversation on our [Discord community](http://discord.eddiehub.org)**
31+
**Join the conversation on our [Discord community](http://discord.eddiehub.org)!**
3332

3433
<!-- DO NOT EDIT THIS SECTION -->
3534
<!--START_SECTION:data-section-->

0 commit comments

Comments
 (0)