diff --git a/README.md b/README.md index 789508a..aa73dfc 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,10 @@ Text-based user interface CSS library
-- Documentation -- +

+ + npm version badge +

### About @@ -18,5 +22,14 @@ TuiCss is a library focused to create web applications using an interface based +### Getting Started +To start to use the TuiCss in your project, you can just download the repository content and import the files that are in the dist folder with the html directives. On the other hand, you can install the package with NPM using the following command: + +```bash +$ npm install tuicss +``` + +For more details, visit the [Getting Started Page](https://github.com/vinibiavatti1/TuiCss/wiki/Getting-Started) in the respoitory wiki. + ### Documentation Check the [repository wiki](https://github.com/vinibiavatti1/TuiCss/wiki) to access the documentation, components index, examples, styles, or to know how to contribute for this project.