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

Merge readme with docs #117

Merged
merged 1 commit into from
Oct 25, 2024
Merged

Merge readme with docs #117

merged 1 commit into from
Oct 25, 2024

Conversation

ThomasdenH
Copy link
Contributor

This PR uses the README file as the top level documentation. This has the advantage of removing duplicate work and of running the examples in the README as doc tests.

Some choices that I made that are worth mentioning:

  • The original example in lib.rs has been moved to the integration test folder.
  • I have added a new example for the parser.
  • The breaking changes in 0.7 has been removed altogether since it is quite a few versions away now. Let me know if I should add it back in.
  • I changed some of the text, for example the parser gets a little more attention than previously. I think this is the most usable/stable/feature-rich ical parser in Rust at the moment!

@ThomasdenH
Copy link
Contributor Author

I missed a space in the commit message, fixed now!

@@ -1,7 +1,5 @@
<div align="center">

Copy link
Owner

Choose a reason for hiding this comment

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

why did you remove the title here?

@hoodie
Copy link
Owner

hoodie commented Oct 25, 2024

cool, thank you so much for the contribution. I'll try to review this over the weekend

@hoodie hoodie merged commit dd48c6c into hoodie:main Oct 25, 2024
6 of 7 checks passed
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