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.

Sign up for GitHub

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

Jump to bottom

README improvements #45

Open
5 of 7 tasks
mjarvis opened this issue Mar 4, 2022 · 0 comments
Open
5 of 7 tasks

README improvements #45

mjarvis opened this issue Mar 4, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone
1.0

Comments

@mjarvis
Copy link
Owner

mjarvis commented Mar 4, 2022 •
edited
Loading

Pull inspiration from other good open source libraries.

  • Badges
  • Swift version / os version support
  • Remove TODO (Ensure issues exist for all items)
  • Remove previewLayout setting from install example
  • Update install example to refer to Exhibition() for display
  • Custom Layout example
  • Small GIF demonstrating basic UI + Debug menu
@mjarvis mjarvis added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Mar 4, 2022
@mjarvis mjarvis added this to the 1.0 milestone Mar 4, 2022
@mjarvis mjarvis mentioned this issue Mar 7, 2022
Merged
mjarvis pushed a commit that referenced this issue Mar 8, 2022
Various README improvements (#52)
c3e3bb8 
Partial work for #45 

* Update installation and usage

Fix usage of exhibition display

* Add CI badge to README

* Remove TODO

Issues list is now complete

* remove `previewLayout` from usage example

This is available through the layout provider

* Add custom layout examples to README

* Make custom presentation example generic
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
1 participant
@mjarvis