From f77c5f7ab7a9f0927115d770bdff5a40cd431259 Mon Sep 17 00:00:00 2001 From: Ernane Ferreira Date: Tue, 10 May 2022 17:01:51 -0300 Subject: [PATCH] Update the development version and standardizes language to English. --- Readme.md | 45 ++++++++++++++++++++++----------------------- package.json | 2 +- 2 files changed, 23 insertions(+), 24 deletions(-) diff --git a/Readme.md b/Readme.md index e904e4d..9ba4092 100644 --- a/Readme.md +++ b/Readme.md @@ -3,8 +3,8 @@
- Projeto   |    - Instalação   |    + Project   |    + Installation   |    Features   |    Use   
@@ -14,19 +14,19 @@ preview star rating

-## 💻 Projeto +## 💻 Project -Simples componente Svelte, sem dependências, para implementação e captura de avaliações por meio de uma interface simples e intuitiva que te levará às etrelas. +Simple Svelte component, with no dependencies, for implementing and capturing assessments through a simple and intuitive interface that will take you to the stars. -[Veja essa demonstração! ](https://svelte.dev/repl/672b083a2ce346a6aae6f07d9e3787f4?version=3.47.0) +[See this demo!! ](https://svelte.dev/repl/672b083a2ce346a6aae6f07d9e3787f4?version=3.47.0) -## 📦 Instalação +## 📦 Installation ```bash $ npm install @ernane/svelte-star-rating # => or yarn ``` -⚠️ se estiver utilizando [SvelteKit](https://kit.svelte.dev/) ou [Sapper](https://sapper.svelte.dev/), é aconselhado instalar como uma dependência de desenvolvimento: +⚠️ if using [SvelteKit](https://kit.svelte.dev/) or [Sapper](https://sapper.svelte.dev/), it is advised to install as a development dependency: ```bash $ npm install @ernane/svelte-star-rating --save-dev # => or yarn @@ -34,36 +34,36 @@ Simples componente Svelte, sem dependências, para implementação e captura de ### 📁 Features -Este pacote exporta um componente svelte que pode, ou não, receber um objeto de configuração com os seguintes atributos. +This package will add a svelte component that may or may not receive a configuration object with the following attributes shown below. -- ⚙️ Configurações Gerais +- ⚙️ General Settings -| atributo | tipo de dado | requerido | valor padrão | +| Attribute | Data Type | Required | Default | |:---------:|:------------:|:---------:|:------------:| | readOnly | `bool` | não | false | | countStars| `integer` | não | 5 | | score | `float` | não | 0.0 | | showScore | `bool` | não | true | -Além disso, temos outros dois atributos aninhados que especificam configurações distintas. +In addition, we have two other nested attributes that specify distinct settings. - 📏 Range -| atributo | tipo de dado | requerido | valor padrão | +| Attribute | Data Type | Required | Default | |:----------:|:------------:|:---------:|:------------:| | min | `integer` | não | 0 | | max | `integer` | não | 5 | | step | `float` | não | 0.001 | -- ⭐ Star Config: +- ⭐ Setting of the Stars: -| atributo | tipo de dado | requerido | valor padrão | +| Attribute | Data Type | Required | Default | |:-----------:|:------------:|:---------:|:------------:| | size | `integer` | não | 30 | | fillColor | `String` | não | #F9ED4F | | strokeColor | `String` | não | #BB8511 | -Ao final, o objeto de configuração será semelhante ao mostrado abaixo. +In the end, the configuration object will be similar to the one shown below. ```js const config = { @@ -86,30 +86,29 @@ const config = { ## 💡 Use -- Importe o componente +- Import the component ```js import StarRatting from "@ernane/svelte-star-rating"; ``` -- Crie o objeto de configuração +- Create the configuration object ```js const config = { ... } ``` - **Como mostrado na seção anterior + **As shown in the previous section -- Por fim, utilize-o! +- Finally, use it! 🎉 ```js ``` - -_Se você desejar implementar ou melhorar alguma feature fique à vontade para enviar uma solicitacao de pull. Adorarei receber!_ +_If you would like to implement or improve any feature feel free to submit a pull request. I would love to receive!_ ---
- Desenvolvido com ❤ por Ernane Ferreira. 👋🏻 -
+ Developed with ❤ by Ernane Ferreira. 👋🏻 + \ No newline at end of file diff --git a/package.json b/package.json index 8c494c7..1afde05 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ernane/svelte-star-rating", - "version": "1.0.3", + "version": "1.1.0", "description": "Simple component to assign scores based on stars.", "main": "dist/index.js", "module": "dist/index.mjs",