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

Improve ReadMe content #14

Merged
merged 3 commits into from
Jun 19, 2024
Merged

Improve ReadMe content #14

merged 3 commits into from
Jun 19, 2024

Conversation

m-triassi
Copy link
Contributor

Summary

Closes #12

Adds a more decriptive and useful readme section.
Outlines how to leverage Contentable and Renderable models, as well as how to dress them with layouts.

@m-triassi m-triassi added the documentation Improvements or additions to documentation label Jun 18, 2024
@m-triassi m-triassi self-assigned this Jun 18, 2024
@m-triassi m-triassi requested review from a-drew and kfriars June 18, 2024 21:00
Copy link
Collaborator

@kfriars kfriars left a comment

Choose a reason for hiding this comment

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

Nice docs improvements. I think ripping Layoutable stuff out of this package and into its own makes sense, as Layoutables will hopefully be replaced by something better eventually.

@m-triassi
Copy link
Contributor Author

Sure, as i was writing the docs it definitely felt like they could exist separately. Lets talk about our plan there later!

@m-triassi m-triassi merged commit 700f235 into main Jun 19, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Readme needs usage instructions
2 participants