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

Update the main README #6

Closed
9 tasks done
jasonwebb opened this issue Aug 15, 2020 · 0 comments
Closed
9 tasks done

Update the main README #6

jasonwebb opened this issue Aug 15, 2020 · 0 comments
Labels
repo maintenance Updates to the repo that do not affect package functionality

Comments

@jasonwebb
Copy link

jasonwebb commented Aug 15, 2020

  • Use a familiar format (at least at the beginning) so its easier for devs to directly swap their package references (jsDelivr URLs, pacman commands, etc).
  • Update the jsDelivr URLs and npm package name once published (see Update package.json and publish completed build to NPM #3).
  • Add a short, clear intro that explains the intent of the repo and links to important sections below.
  • Add a "Why is this needed?" section
  • Add a "What makes this accessible?" section listing out all feature additions and changes.
  • Add a "Usage" section that piggy-backs on the original Slick Slider documentation.
  • Add a "Development" section that explains the updates made to the repo and build system, and how to build it locally.
  • Add a "Contributing" section.
  • Add a "Credits" section.
    • Ken Wheeler, contributor community, and Accessible360 (logo).
@jasonwebb jasonwebb added the repo maintenance Updates to the repo that do not affect package functionality label Aug 15, 2020
jasonwebb added a commit that referenced this issue Aug 15, 2020

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
…uctions, adding initial "why" section
jasonwebb added a commit that referenced this issue Aug 16, 2020
jasonwebb added a commit that referenced this issue Aug 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
repo maintenance Updates to the repo that do not affect package functionality
Projects
None yet
Development

No branches or pull requests

1 participant