]> git.ipfire.org Git - thirdparty/vuejs/pinia.git/commitdiff
chore: update readme [skip ci]
authorEduardo San Martin Morote <posva13@gmail.com>
Mon, 8 Mar 2021 10:08:30 +0000 (11:08 +0100)
committerEduardo San Martin Morote <posva13@gmail.com>
Mon, 8 Mar 2021 10:08:30 +0000 (11:08 +0100)
README.md
package.json

index 0e0d747537d23b71af9ce219e52f4b252d848e0b..e1fb153c694acfcd6dfd60df69c9581456db72fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,28 +1,32 @@
-# Pinia [![Build Status](https://badgen.net/circleci/github/posva/pinia/v2)](https://circleci.com/gh/posva/pinia) [![npm package](https://badgen.net/npm/v/pinia/next)](https://www.npmjs.com/package/pinia) [![coverage](https://badgen.net/codecov/c/github/posva/pinia/next)](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
+<p align="center">
+  <a href="https://pinia.esm.dev" target="_blank" rel="noopener noreferrer">
+    <img width="180" src="https://pinia.esm.dev/logo.svg" alt="Pinia logo">
+  </a>
+</p>
+<br/>
+<p align="center">
+  <a href="https://npmjs.com/package/pinia"><img src="https://badgen.net/npm/v/pinia/next" alt="npm package"></a>
+  <a href="https://app.circleci.com/pipelines/github/posva/pinia?branch=v2"><img src="https://circleci.com/gh/posva/pinia/tree/v2.svg?style=shield" alt="build status"></a>
+  <a href="https://codecov.io/github/posva/pinia"><img src="https://badgen.net/codecov/c/github/posva/pinia/v2" alt="code coverage"></a>
+</p>
+<br/>
 
-🍍 Automatically Typed, Modular and lightweight Store for Vue 3.x based on the composition api with devtools support
+# Pinia
 
-## 👉 [Demo on CodeSandbox](https://j4qzw.csb.app/)
+> Intuitive, type safe and flexible Store for Vue
 
-Pinia works both for Vue 2.x and Vue 3.x and you are currently on the branch that supports Vue 3.x. [Go here for the Vue 2.x compatible version](https://github.com/posva/pinia/tree/v1).
+- 💡 Intuitive
+- 🔑 Type Safe
+- ⚙️ Devtools support
+- 🔌 Extensible
+- 🏗 Modular by design
+- 📦 Extremely light
 
-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.
+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.
 
-These are the core principles that I try to achieve with this experiment:
+## 👉 [Demo on CodeSandbox](https://j4qzw.csb.app/)
 
-- Autocompletion: even if you write your code in JavaScript!
-- Flat modular structure 🍍 No nesting, only stores, compose them as needed
-- Light layer on top of Vue 💨 keep it very lightweight
-- Only `state`, `getters` and `actions`
-- No more verbose mutations, 👐 `patch` is _**the** mutation_
-- Actions are like _methods_ ⚗️ Group your business logic 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 works both for Vue 2.x and Vue 3.x and you are currently on the branch that supports Vue 3.x. [Go here for the Vue 2.x compatible version](https://github.com/posva/pinia/tree/v1).
 
 ## Help me keep working on this project 💚
 
index 87b001ccc295a86636532ade4a277b45fadde245..5f763991bc7986fc13f141e0ae4d9f83651c7628 100644 (file)
@@ -1,7 +1,7 @@
 {
   "name": "pinia",
   "version": "2.0.0-alpha.7",
-  "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",