@dito-uai/components 5.1.0-alpha.5 → 5.1.0-alpha.51

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Dito Internet Ltda.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,45 @@
-# uai
+# How to run the project on you local
+
+The project has 3 packages:
+
+- foundation _that has all informations of colors, typhograph, grid and others_
+- icons _that has all separeted icons_
+- uai _that has all components_
+
+1. Enter on package and run `yarn` to install all dependencies
+2. Run `yarn start` to preview the **storybook**
+
+## How to commit on this repo
+
+The project has a default template to commit, just use `yarn cz` and go ahead with the steps
+
+## Before installing
+
+### Using Github Package Registry: (only for private package)
+
+First, [issue a personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) for the command line with the `read:packages` and `write:packages` permissions.
+
+The recommended setup for authenticating with Github Package Registry is creating the `~/.npmrc` file containing:
+
+```
+//npm.pkg.github.com/:_authToken=PERSONAL-ACCESS-TOKEN
+```
+
+## Install
+
+We highly recommend you to check our latest tag on the [releases page](https://github.com/ditointernet/dito-uai/releases/latest) and [packages page](https://github.com/ditointernet/dito-uai/packages/23637) and use exact-versions, to make upgrading easier:
+
+Package uai-components
+```bash
+yarn add @ditointernet/uai-components
+```
+
+Package uai-foundation
+```bash
+yarn add @ditointernet/uai-foundation
+```
+
+Package uai-icons
+```bash
+yarn add @ditointernet/uai-icons
+```