From 4502b3a16a868f1489eb277c753f9243b8ba3b63 Mon Sep 17 00:00:00 2001 From: Vinicius Reif Biavatti Date: Thu, 31 Dec 2020 18:39:47 +0000 Subject: [PATCH 1/5] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 789508a..7db0e2f 100644 --- a/README.md +++ b/README.md @@ -18,5 +18,12 @@ 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 +``` + ### 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. From 2b45410389a8fe1d28abc4f8a6afe9b6678e14d3 Mon Sep 17 00:00:00 2001 From: Vinicius Reif Biavatti Date: Thu, 31 Dec 2020 18:40:40 +0000 Subject: [PATCH 2/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7db0e2f..8fa1c6f 100644 --- a/README.md +++ b/README.md @@ -25,5 +25,7 @@ To start to use the TuiCss in your project, you can just download the repository $ npm install tuicss ``` +For more details, visit the [Getting Started Page](https://github.com/vinibiavatti1/TuiCss/wiki) 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. From e110177a798c7eb2ba3a45f97b220e02a0b99b22 Mon Sep 17 00:00:00 2001 From: Vinicius Reif Biavatti Date: Thu, 31 Dec 2020 18:40:58 +0000 Subject: [PATCH 3/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8fa1c6f..aac7000 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ To start to use the TuiCss in your project, you can just download the repository $ npm install tuicss ``` -For more details, visit the [Getting Started Page](https://github.com/vinibiavatti1/TuiCss/wiki) in the respoitory wiki. +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. From 2ad89f2a9ae0a34dfecc602888f42f7cf3ebcf12 Mon Sep 17 00:00:00 2001 From: Vinicius Reif Biavatti Date: Thu, 31 Dec 2020 18:43:55 +0000 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index aac7000..1488f80 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,10 @@ Text-based user interface CSS library
-- Documentation -- +
+ + npm version badge +

### About From 2594e1252cea7a5e19b8b1224e923036661f399a Mon Sep 17 00:00:00 2001 From: Vinicius Reif Biavatti Date: Thu, 31 Dec 2020 18:44:08 +0000 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1488f80..aa73dfc 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Text-based user interface CSS library
-- Documentation -- -
+

npm version badge