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

Update Clay's README.md #4671

Closed
sergiojimcos opened this issue Feb 15, 2022 · 0 comments · Fixed by #4675
Closed

Update Clay's README.md #4671

sergiojimcos opened this issue Feb 15, 2022 · 0 comments · Fixed by #4675
Labels
comp: documentation Issues related to documentation in general, be clayui.com or other means... rfc Similar to the RFC that are used in React.js, Ember.js, Gatsby.js and Rust, but to mark problems tha

Comments

@sergiojimcos
Copy link
Contributor

What is your proposal?

According what it have been said during Clay's meeting, one of the point that have been discussed was the idea of update Clay's README in order to make an instructive and brief descriptive repository.

Why would adopting this proposal be beneficial?

This change will be beneficial to Clay's repository in order to make an intuitive and descriptive README which contains a brief explanation of what is Clay, a table of contents, some information related to the browsers that can be used, GitHub's tags (it is optional but could be interesting when a user wants to search it) and all the steps that includes the installation of Clayui.com and the Storybook. It is necessary to include the License.
@sergiojimcos sergiojimcos added comp: documentation Issues related to documentation in general, be clayui.com or other means... rfc Similar to the RFC that are used in React.js, Ember.js, Gatsby.js and Rust, but to mark problems tha labels Feb 15, 2022
@sergiojimcos sergiojimcos mentioned this issue Feb 16, 2022
Merged
@matuzalemsteles matuzalemsteles linked a pull request Feb 17, 2022 that will close this issue
docs(README): Update README structure #4675
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
comp: documentation Issues related to documentation in general, be clayui.com or other means... rfc Similar to the RFC that are used in React.js, Ember.js, Gatsby.js and Rust, but to mark problems tha
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(README): Update README structure sergiojimcos/clay
2 participants
@matuzalemsteles @sergiojimcos