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 #3148

Merged
merged 4 commits into from Mar 10, 2024
Merged

Update README.md #3148

merged 4 commits into from Mar 10, 2024

Conversation

MyPingO
Copy link
Contributor

@MyPingO MyPingO commented Mar 9, 2024

Added links to the Discord server and the Matrix room

Added links to the Discord server and the Matrix room
@amaanq
Copy link
Member

amaanq commented Mar 10, 2024

it'd be nicer to make them badges like here

Added badges [as requested](#3148 (comment))

Added a badge for the npm link as well for consistency with other readme's
@MyPingO
Copy link
Contributor Author

MyPingO commented Mar 10, 2024

Not sure how important the zenodo badge is, so I made it go last

@amaanq
Copy link
Member

amaanq commented Mar 10, 2024

keep it first, and if you're gonna add the npm badges add both the lib and cli and both rust badges.

@MyPingO
Copy link
Contributor Author

MyPingO commented Mar 10, 2024

I wasn't sure if I should because there are links for them there already. Should I replace the relevant links with badges?

README.md Outdated
@@ -1,5 +1,8 @@
# tree-sitter

[![discord][discord]](https://discord.gg/w7nTvsVJhm)
[![matrix][matrix]](https://matrix.to/#/#tree-sitter-chat:matrix.org)
[![npm][npm]](https://www.npmjs.com/package/tree-sitter)
Copy link
Member

Choose a reason for hiding this comment

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

Should link to the tree-sitter-cli package instead.

@amaanq
Copy link
Member

amaanq commented Mar 10, 2024

those just link to the readme, not registry page. you can just omit the npm package and limit the scope of this pr to just add chat badges

keeping the scope of commit only to chat links
@MyPingO
Copy link
Contributor Author

MyPingO commented Mar 10, 2024

those just link to the readme, not registry page.

The linked readme's have badges to the registry page, wasn't sure if it's better to keep it that way to reduce redundancy, probably doesn't matter either way.

@amaanq
Copy link
Member

amaanq commented Mar 10, 2024

oh right, yeah that's fine as is

@amaanq amaanq merged commit aa0f3c2 into tree-sitter:master Mar 10, 2024
@MyPingO MyPingO deleted the patch-1 branch March 10, 2024 15:31
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

3 participants