From 6673dbd3c55d01338711e0e0aa022972ce978e96 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 31 Aug 2021 00:19:25 +0000 Subject: [PATCH 1/3] Updating the README! From 8c3bfff0c9748ccb6d1a1b2a8bf4e17e0ed6e79f Mon Sep 17 00:00:00 2001 From: David Leal Date: Mon, 30 Aug 2021 19:24:32 -0500 Subject: [PATCH 2/3] Improve `README.md` --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 7a6e90be..7ef0b881 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,19 @@ -# Awesome Github Profiles +# Awesome GitHub profiles ![.github/workflows/main.yml](https://github.com/EddieJaoudeCommunity/awesome-github-profiles/workflows/.github/workflows/main.yml/badge.svg) -List of GitHub profiles that have awesome customisation, that you can use for inspiration. +List of GitHub profiles that have awesome customisation, that you can use for inspiration.\ +Feel free to submit a pull request with your suggestions of awesome GitHub profiles. -Feel free to submit a pull request with your suggestions of awesome github profiles. +## How can I add my GitHub profile? -## To add your github profile - -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) +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) 2. Fork the project -3. In `data.json` add your own object to the end of the file, your entry should be similar to this example: +3. In the `data.json` file, add your own object to the end of the file. Your entry should be similar to this example: -```typescript +```json { "name": "Eddie Jaoude", "githubUsername": "eddiejaoude", @@ -23,13 +22,13 @@ Feel free to submit a pull request with your suggestions of awesome github profi } ``` -**Note** : Please do not edit anything below `` in `README.MD` our [GitHub Action](https://github.com/EddieJaoudeCommunity/gh-action-community) will make the necessary changes for you. +**Note** : Please do not edit anything below `` in `README.md`. Our [GitHub Action](https://github.com/EddieJaoudeCommunity/gh-action-community) will make the necessary changes for you. 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` -Any questions let us know! +Any questions, let us know! -**Join the conversation on our [Discord community](http://discord.eddiehub.org)** +**Join the conversation on our [Discord community](http://discord.eddiehub.org)!** From 84e2c74f5b35f28d84913c7c90e9b87924a42f6d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 31 Aug 2021 00:24:44 +0000 Subject: [PATCH 3/3] Updating the README!