Skip to content

Update README with versioning notes#172

Merged
djc merged 3 commits into
v0.1.xfrom
readme-updates
Oct 9, 2024
Merged

Update README with versioning notes#172
djc merged 3 commits into
v0.1.xfrom
readme-updates

Conversation

@djc

@djc djc commented Oct 9, 2024

Copy link
Copy Markdown
Collaborator

Alternative to #171.

djc and others added 2 commits October 9, 2024 10:44

@Xuanwo Xuanwo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you for polishing the README!

@djc djc merged commit 74d6ba0 into v0.1.x Oct 9, 2024
@jlandahl

Copy link
Copy Markdown
Contributor

@djc I see that you moved the basic example out of the readme and into the examples. I think you could have left it in the readme, as it's not taking up a lot of space, and the updates to the Cargo.toml snippet was also very useful for new adopters. It also gave a clearl visual example of the versioning differences mentioned in the new note.

I had also added some useful explanatory text around the Jaeger example, including a fully tested Cargo.toml snippet that would help anyone who wanted to try that code in their own project. I think that should have stayed, as the full Cargo.toml in this repo has a lot of extra dependencies and enabled features which I had pared down to just what was necessary to run that code from an independent project.

Maybe I'll submit a new readme for the examples directory with that info.

@djc

djc commented Oct 11, 2024

Copy link
Copy Markdown
Collaborator Author

@jlandahl code in the README will tend to get out of date because there's no CI checking that it still compiles, so I'd rather have pointers to code that is known to compile. Happy to take further improvements to either the top-level README and/or an extra README for the examples!

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.

3 participants