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 quick start & component info in readme #23

Merged
merged 1 commit into from
Feb 20, 2024

Conversation

jacobras
Copy link
Contributor

@jacobras jacobras commented Feb 19, 2024

This change includes:

  • Quick start info (about CupertinoTheme and AdaptiveTheme)
  • An overview of most of the (adaptive) components to the readme
  • A link to my adaptive tutorial (I can remove it if you don't want it in the readme but I figured it makes sense as it offers a step-by-step introduction to using the library based on the well known KMP starter template)
  • Info about using AdaptiveWidget for custom widgets
  • Updates the Compose badge to 1.6.0-rc01 since that's the current version (RC2 is already out btw 😀)

I took some quick screenshots of some of the components to make the page a bit more visual and lead readers to what they're looking for. They're all exported at a maximum width of 300px.

You can check what this would look like on the repo in my fork: https://github.com/jacobras/compose-cupertino/tree/docs-improvement

@alexzhirkevich
Copy link
Owner

Can you please move it to the separate file Adaptive.md to the docs directory and left a link to it in a readme

README.md Outdated Show resolved Hide resolved
@jacobras
Copy link
Contributor Author

Can you please move it to the separate file Adaptive.md to the docs directory and left a link to it in a readme

Sure! Will update it today.

@jacobras jacobras force-pushed the docs-improvement branch 5 times, most recently from e98f71c to 6af261c Compare February 20, 2024 10:43
@jacobras
Copy link
Contributor Author

Can you please move it to the separate file Adaptive.md to the docs directory and left a link to it in a readme

Sure! Will update it today.

PR updated @alexzhirkevich

Copy link
Owner

@alexzhirkevich alexzhirkevich left a comment

Choose a reason for hiding this comment

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

Thanks!

@alexzhirkevich alexzhirkevich merged commit b642826 into alexzhirkevich:master Feb 20, 2024
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