search

Capgemini / dcx-react-library

React Library UI/UX agnostic
https://main--6069a6f47f4b9f002171f8e1.chromatic.com
MIT License
107 stars 7 forks source link

[enhancement - docs - README.md] - improve grammar and syntax #583

Closed tmm88 closed 6 months ago

tmm88 commented 7 months ago

Enhancement - Documentation - README.md

Purpose: Improve grammar and syntax

Description: This task involves enhancing the grammar and syntax in the README.md file to ensure clarity and coherence in the documentation. The focus is on refining the language used throughout the document for an improved user experience and understanding.

daniele-zurico commented 7 months ago

@aetj2023 thanks a lot for your awesome PR it's really appreciated. A couple of notes:

  1. can you please create the PR against the branch release/1.0.0 ?
  2. can you please add something like: " if you using dcx-react-library let us know(daniele.zurico@capgemini.com) ... we never gonna charge you but will help us motivating to continue implement new features and new components
  3. if you look in release/1.0.0 for some component already in storybook there's an extra folder called "design system" that is based on tokens... can you document that as well (at line 21 of the readme.md)?

Aside that can I know if you part of Capgemini or somewhere else and how did you find us?