@dxc-technology/halstack-react 0.0.0-c7ec4d1 → 0.0.0-c813cd0

package/README.md

@@ -1,66 +1,46 @@
-# Halstack React CDK 
+<p align="center">
+  <a href="https://developer.assure.dxc.com/halstack/">
+    <img src="apps/website/screens/common/images/halstack_logo.svg" alt="Halstack Design System logo" />
+  </a>
+</p>
 
-Halstack React CDK is a npm library of reusable React components, made with the purpose of helping React developers with the task of implementing User Interfaces following the DXC Design Guidelines.
+<h1 align="center">Halstack Design System</h1>
 
-- It increases visual and behavioral consistency across the applications using the library.
+Halstack is an Open Source Design System built and maintained by DXC Technology with the purpose of providing all the necessary tools for designing and implementing accessible, intuitive and consistent User Experiences with React.
 
-- It cuts down development efforts, taking the responsability of following the Design Guidelines away from the developer, and allowing him to focus on providing business value.
+## How to start
 
-## Usage
-
-Halstack React CDK is a set of reusable components distributed as a npm library. See the [documentation site](https://developer.dxc.com/tools/react/) for details on how to use it.
-
-## Contributing
-
-Before opening new issues or pull requests, please refer to [CONTRIBUTING.MD](https://github.com/dxc-technology/halstack-react/blob/master/CONTRIBUTING.md).
-
-## Development Setup
-
-These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. 
-
-
-The project is divided in two main folders. One is for the actual library, and the other one is a React application using the library.
-
-### Library
-
-Contained in the `lib` folder.
+You can start using Halstack right now:
 
 ```bash
-cd lib
+npm i @dxc-technology/halstack-react
 ```
 
-Install the library dependencies.
-
-```bash
-npm install
-```
+### Usage
 
-Run the build process into `dist` folder, detecting and automatically building changes in src.
+```jsx
+import { DxcButton, DxcTextInput } from "@dxc-technology/halstack-react";
 
-```bash
-npm run build:watch #'npm run build' if there is no need to watch for changes
+const App = () => (
+  <>
+    <DxcTextInput label="Enter your name" />
+    <DxcButton label="Submit" type="submit" />
+  </>
+);
 ```
 
-### Example Application
+## Where to start
 
-Contained in the `app` folder.
-
-```bash
-cd app # from the root folder
-```
+Learn everything you need to know about Halstack guidelines and components on the [official documentation site](https://developer.assure.dxc.com/halstack).
 
-Install the application dependencies. The Halstack React CDK dependency is linked to the local `lib` folder. This one must have been previously built.
+## Contributing
 
-```bash
-npm install
-```
+Any feedback is always welcome in Halstack!
 
-Start the application.
+Before opening a new issue, pull request or discussion, please read carefully and respect our [contribution guidelines](https://github.com/dxc-technology/halstack-react/wiki/Contributing).
 
-```bash
-npm start # runs create-react-app dev server
-```
+## Thanks
 
-Now, anytime you make a change to the library or the app, `create-react-app` will live-reload your local dev server so you can iterate on your component in real-time.
+<a href="https://www.chromatic.com/"><img src="https://user-images.githubusercontent.com/321738/84662277-e3db4f80-af1b-11ea-88f5-91d67a5e59f6.png" width="153" height="30" alt="Chromatic" /></a>
 
-## Running the tests
+Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions.