@tiller-ds/util - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "@tiller-ds/util",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "main": "./util.umd.js",
@@ -5,0 +5,0 @@ "module": "./util.esm.js",

README.md

@@ -1,9 +0,3 @@
-<img src="img/croz_logo.png" alt="Croz Logo" width="64px"> Tiller Design System
+![Tiller cover image](https://raw.githubusercontent.com/croz-ltd/tiller/master/img/tiller_cover.png)
 
----
-
-[//]: # (//TODO: fix URLs )
-
-![Tiller cover image](img/tiller_cover.png "Tiller development")
-
 ## <h1 align="center">Tiller Design System</h1>
@@ -16,3 +10,3 @@
   <a href="https://github.com/croz-ltd/tiller/actions/workflows/build.yml">
-    <img src="https://github.com/croz-ltd/nrich-demo-frontend/actions/workflows/build.yml/badge.svg" alt="CI workflow status" />
+    <img src="https://github.com/croz-ltd/tiller/actions/workflows/build.yml/badge.svg" alt="CI workflow status" />
   </a>
@@ -27,9 +21,8 @@ <a href="https://github.com/croz-ltd/tiller/blob/master/CONTRIBUTING.md">
 **Tiller Design System** is open-source UI library which offers a set of visual, functional components and patterns that accelerate design and development. Components are endlessly customizable, accessible, and can integrate into any application with primarily focus on back-office applications. <br>
-Tiller design system is based on **Tailwind UI/CSS, Formik** and **ReachUI**. Besides these, Tiller is made with the help of **Nx, Yarn 2, Storybook** and **Codemod**.
+Tiller design system is based on **Tailwind CSS, Formik** and **ReachUI**. Besides these, Tiller is made with the help of **[Nx](https://nx.dev/), [Yarn 2](https://yarnpkg.com/)** and **[Storybook](https://storybook.js.org/)**.
 
-| Package Name                                                                       | Version                                                          |
-|------------------------------------------------------------------------------------|------------------------------------------------------------------|
-| [@tiller-ds/util](https://www.npmjs.com/package/@tiller-ds/util)                   | ![](https://img.shields.io/npm/v/tiller-ds/util/latest)          |
-| [@tiller-ds/cra-template](https://www.npmjs.com/package/@tiller-ds/cra-template)   | ![](https://img.shields.io/npm/v/tiller-ds/cra-template/latest)  |
-| [@tiller-ds/vite-template](https://www.npmjs.com/package/@tiller-ds/vite-template) | ![](https://img.shields.io/npm/v/tiller-ds/vite-template/latest) |
+| Package Name                                                                     | Version                                                          |
+|----------------------------------------------------------------------------------|------------------------------------------------------------------|
+| [@tiller-ds/util](https://www.npmjs.com/package/@tiller-ds/util)                 | ![](https://img.shields.io/npm/v/@tiller-ds/util/latest)         |
+| [@tiller-ds/cra-template](https://www.npmjs.com/package/@tiller-ds/cra-template) | ![](https://img.shields.io/npm/v/@tiller-ds/cra-template/latest) |
 
@@ -46,6 +39,20 @@ ## ✨ Features
 
-## 📚 Documentation
+## 🎨 Tiller Design System - Figma UI Kit
 
-- http://tiller-storybook-development.tos-cloud.lan.croz.net/
+Tiller DS **UI kit** in **Figma** is a collection of Tiller components that allow you to easily create user interfaces for your **Figma projects**. It includes common components like buttons, input fields, and menus, as well as more specialized components, like Formik components or Login Pattern.
 
+- [Figma UI Kit](https://www.figma.com/file/QVaavJ0ZFn1AOsBnTjr7F1/Tiller-Design-System---UI-KIT?node-id=8627%3A11169&t=F3NI5LM7tIG1qSnq-0)
+
+## 📚 Tiller Docs & Storybook
+
+For more information about **Tiller Design System**, please refer to:
+
+- [Storybook](https://croz-ltd.github.io/tiller/?path=/docs/introduction--page) 
+  - Usage documentation for each component
+  - Prop documentation for each component
+  - Factories for a number of components to easily visualize and create components
+  - Code preview for each story
+- [GitHub](https://github.com/croz-ltd/tiller)
+- [npm](https://www.npmjs.com/package/@tiller-ds/core)
+
 ## 🚀 Getting Started
@@ -69,5 +76,10 @@
    ```
-   npx degit croz-ltd/tiller-vite
+   npx degit croz-ltd/tiller-starter-vite
    ```
-4. Run `yarn run` command to start your project
+4. Then run these commands to start your project
+   ```
+   cd %PROJECT_NAME%
+   yarn install
+   yarn run dev
+   ```
 
@@ -111,3 +123,3 @@ ### Installation with custom project setup
 Customizations on theme level are implemented using design tokens which we call Tiller tokens.
-For guides on Tiller tokens, head on over to our Storybook - [Theming and Customization](http://tiller-storybook-development.tos-cloud.lan.croz.net/?path=/story/theming-and-customization--page).
+For guides on Tiller tokens, head on over to our Storybook - [Theming and Customization](https://croz-ltd.github.io/tiller/?path=/docs/theming-and-customization--page).
 
@@ -132,6 +144,13 @@ Tiller Design System is divided into **modules**.
  - `@tiller-ds/upload`
- - `@tiller-ds/utils`
+ - `@tiller-ds/util`
 
-For more information about each component, check out our [Storybook](http://tiller-storybook-development.tos-cloud.lan.croz.net/).
+For more information about each component, check out our [Storybook](https://croz-ltd.github.io/tiller/?path=/docs/introduction--page).
 
+## Versions
+Every monday, a new version of the tiller packages will be published.
+Whether is minor or major will depend on the tasks completed the week before. If there is no new version on monday, it means there hasn't been enough changes to update the version.
+
+### Version ranges
+We stick to the [semantic versioning](https://semver.org/), meaning that every breaking change is published as a new major version of the Tiller packages.
+
 ## Frequently asked questions
@@ -138,0 +157,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

163014

increased by0.74%

Number of lines in readme file

175

increased by12.18%

No dependency changes