Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #732

Merged
merged 4 commits into from Oct 30, 2022
Merged

Conversation

Abinashbunty
Copy link
Contributor

@Abinashbunty Abinashbunty commented Oct 9, 2022

Updated the sponsors correctly

Reference issue

What does this implement/fix?

Additional information

CheckList

  • Did you add an unittest for your new example or defect fix?
  • Did you add documents for your new example?
  • All CIs are green? (You can check it after submitting)

Updated the sponsors correctly
README.md Outdated

They are providing a free license of their IDEs for this OSS development.

### [1Password](https://github.com/1Password/1password-teams-open-source)
### <a id="1password"></a>[1Password](https://github.com/1Password/1password-teams-open-source)
Copy link
Owner

@AtsushiSakai AtsushiSakai Oct 10, 2022

Choose a reason for hiding this comment

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

Why did you add a tag?

Copy link
Contributor Author

@Abinashbunty Abinashbunty Oct 10, 2022

Choose a reason for hiding this comment

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

The tag makes a direct reference to the sponsor when clicked on at the sponsors from the list items towards the top in Readme.

Copy link
Owner

@AtsushiSakai AtsushiSakai Oct 10, 2022

Choose a reason for hiding this comment

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

Is it needed? I think header TOC items already links to each Markdown header when TOC item and markdown header are matched.

Copy link
Contributor Author

@Abinashbunty Abinashbunty Oct 10, 2022

Choose a reason for hiding this comment

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

Actually 1Password was not present on the list. So while adding it, I modified it below as well by adding a tag. It wasn't necessary but added to make the complete thing.

Only its inclusion in the sponsors section was necessary.

Shall I remove the tag then?

Copy link
Contributor Author

@Abinashbunty Abinashbunty Oct 10, 2022

Choose a reason for hiding this comment

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

I removed the tag now. So only its inclusion in the list was the change. 😄

Remove the tag.
Updated development references and styled the single line codes in "How to use" section
@Abinashbunty
Copy link
Contributor Author

Abinashbunty commented Oct 10, 2022

I added the references to development section and also styled the single line codes in "How to use" section.

Styled single-line comments using syntax highlighting for markdown
@Abinashbunty Abinashbunty requested a review from AtsushiSakai Oct 11, 2022
@Abinashbunty
Copy link
Contributor Author

Abinashbunty commented Oct 15, 2022

Hi @AtsushiSakai Can this be reviewed? Thanks! 😄

@AtsushiSakai
Copy link
Owner

AtsushiSakai commented Oct 15, 2022

i’m so sorry, I’m very busy in this month.. Let me check later.

@Abinashbunty
Copy link
Contributor Author

Abinashbunty commented Oct 15, 2022

Sure. No worries. Just thought of letting you know that I had made the changes you had requested. 😃😅

Copy link
Owner

@AtsushiSakai AtsushiSakai left a comment

LGTM. Thank you.

@AtsushiSakai AtsushiSakai merged commit 39472e6 into AtsushiSakai:master Oct 30, 2022
8 checks passed
@Abinashbunty Abinashbunty deleted the readme-branch branch Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants