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

add links to consuming projects in readme #130

Merged
merged 2 commits into from
Sep 27, 2024
Merged

add links to consuming projects in readme #130

merged 2 commits into from
Sep 27, 2024

Conversation

guybedford
Copy link
Contributor

This updates the readme to note projects which are using StarlingMonkey (expected to be a list that can grow over time), which also seems useful for users to easily find where to use StarlingMonkey without having to build it themselves.

Copy link
Member

@tschneidereit tschneidereit left a comment

Choose a reason for hiding this comment

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

Adding this makes a lot of sense, yes. I wonder though if we shouldn't introduce an ADOPTERS file like other projects have? E.g. Wasmtime has such a file, with a structure I quite like.

We could then include a link to that file as part of a single-sentence paragraph here.

@guybedford
Copy link
Contributor Author

Nice, one counter argument is that I did not know that page existed until you mentioned it. I really like the format though and table, but I think highlighting production users at the forefront of the readme can help build confidence in the project.

@tschneidereit
Copy link
Member

I agree, yes. That's what I was trying to address with the suggestion of including a mention/link in the README, but maybe inlining it is still the better call. In that case, maybe we do the inverse: introduce an ADOPTERS file that just contains a sentence with a link to this section of the README, so people expecting that kind of pattern immediately find what they're looking for?

@guybedford
Copy link
Contributor Author

Added a separate file and short summary, let me know your thoughts.

Copy link
Member

@tschneidereit tschneidereit left a comment

Choose a reason for hiding this comment

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

I like it!

@guybedford guybedford merged commit afcb458 into main Sep 27, 2024
4 checks passed
@guybedford guybedford deleted the readme-links branch September 27, 2024 16:24
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.

2 participants