From 47199b04a5860c6d147d511843ea8a3e0087b2bc Mon Sep 17 00:00:00 2001 From: Eduardo San Martin Morote Date: Mon, 8 Mar 2021 11:08:16 +0100 Subject: [PATCH] chore: update readme --- README.md | 43 +++++++++++++++++++++---------------------- package.json | 2 +- 2 files changed, 22 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 04c87ec7..5467ed5f 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,28 @@ -# Pinia [![Build Status](https://badgen.net/circleci/github/posva/pinia/v1)](https://circleci.com/gh/posva/pinia) [![npm package](https://badgen.net/npm/v/pinia)](https://www.npmjs.com/package/pinia) [![coverage](https://badgen.net/codecov/c/github/posva/pinia/v1)](https://codecov.io/github/posva/pinia) [![thanks](https://badgen.net/badge/thanks/♥/pink)](https://github.com/posva/thanks) - -> Pronounced like the fruit in Spanish, _Piña_ -> -> _Piña_ is also an invalid package name... that's why it has to be _pinia_ which sounds very similar - -🍍Automatically Typed, Modular and lightweight Store for Vue based on the composition api with devtools support - -## 👉 [Demo](https://vcuiu.csb.app/) - -Pinia works for Vue 2 by using the [official plugin](https://github.com/vuejs/composition-api) to add Composition API support to Vue 2. +

+ + Pinia logo + +

+
+

+ npm package + build status + code coverage +

+
-**If you are looking for the version compatible with Vue 3.x, check the [`v2` branch](https://github.com/posva/pinia/tree/v2)** +# Pinia -What I want is to inspire others to think about ways to improve Vuex and come up with something that works very well with the composition api. Ideally it could also be used without it. Note **@vue/composition-api must be installed and used by your application** for Pinia to work. +> Intuitive, type safe and flexible Store for Vue -There are the core principles that I try to achieve with this experiment: +- 💡 Intuitive +- 🔑 Type Safe +- ⚙️ Devtools support +- 🔌 Extensible +- 🏗 Modular by design +- 📦 Extremely light -- Flat modular structure 🍍 No nesting, only stores, compose them as needed -- Light layer on top of Vue 💨 keep it very lightweight -- Only `state`, `getters` -- No more verbose mutations, 👐 `patch` is _the mutation_ -- Actions are like _methods_ ⚗️ Group your business there -- Import what you need, let webpack code split 📦 No need for dynamically registered modules -- SSR support ⚙️ -- DevTools support 💻 Which is crucial to make this enjoyable +Pinia is is the most similar English pronunciation of the word _pineapple_ in Spanish: _Piña_. A pineapple is in reality a group of individual of flowers that join together to create a multiple fruit. Similar to stores, each one is born individually, but they are all connected at the end. It's also a delicious tropical fruit indigenous to South America. **Help me keep working on Open Source in a sustainable way 🚀**. Help me with as little as \$1 a month, [sponsor me on Github](https://github.com/sponsors/posva). diff --git a/package.json b/package.json index 3513f06f..76fa1210 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "pinia", "version": "0.1.0", - "description": "Intuitive, type safe and light Store for Vue", + "description": "Intuitive, type safe and flexible Store for Vue", "main": "dist/pinia.cjs.js", "module": "dist/pinia.esm-bundler.js", "unpkg": "dist/pinia.global.js", -- 2.47.3