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

feat(readme): overview #540

Merged
merged 1 commit into from
Oct 1, 2020
Merged

Conversation

reubenae
Copy link

@reubenae reubenae commented Oct 1, 2020

What Changed

Updated the readme with the start of an overview section

Why

For people landing on this repo, the benefit should be immediately obvious. The sooner the benefit can be understood, the more widely it will be adopted. This kicks that off.

Relates to #532

Todo:

  • Add tests
  • Add docs
📦 Published PR as canary version: 2.5.4-canary.540.10268.0

✨ Test out this PR locally via:

npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
npm install @design-systems/[email protected]
# or 
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]
yarn add @design-systems/[email protected]

@hipstersmoothie hipstersmoothie added the documentation Changes only affect the documentation label Oct 1, 2020
@hipstersmoothie hipstersmoothie merged commit 8c29bb7 into intuit:master Oct 1, 2020
@reubenae
Copy link
Author

reubenae commented Oct 1, 2020

Ah, I was planning to add more to this. I'll create another PR for that!

@hipstersmoothie
Copy link
Contributor

🚀 PR was released in v2.5.4 🚀

@hipstersmoothie hipstersmoothie added the released This issue/pull request has been released. label Oct 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants