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 #532

Open
tylerkrupicka opened this issue Oct 1, 2020 · 1 comment
Open

Improve ReadMe #532

tylerkrupicka opened this issue Oct 1, 2020 · 1 comment
Labels
enhancement New feature or request hacktoberfest Great for contribution during hacktoberfest.

Comments

@tylerkrupicka
Copy link
Contributor

The ReadMe for this project is a little bare-bones. While we have a documentation site, it would be nice to include some more information explaining why the project exists and how it is useful.

Since DS-CLI is basically a Create React App for design systems, I think some of the elements of the CRA readme would be good to include.

Installation guide, video setting up a new design system, philosophy, features etc would all be useful. We really should hammer that setting up all of the monorepo, Storybook, and build tools takes over a week if you piece it together yourself. You can do it with this project in minutes.

@tylerkrupicka tylerkrupicka added enhancement New feature or request hacktoberfest Great for contribution during hacktoberfest. labels Oct 1, 2020
@reubenae reubenae mentioned this issue Oct 1, 2020
2 tasks
@anjaliguptaz
Copy link

@tylerkrupicka I can take a stab at this .Please assign :)

anjaliguptaz pushed a commit to anjaliguptaz/design-systems-cli that referenced this issue Oct 9, 2020
hipstersmoothie added a commit that referenced this issue Oct 13, 2020
Improve ReadMe #532 #hacktoberfest
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest Great for contribution during hacktoberfest.
Projects
None yet
Development

No branches or pull requests

2 participants