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

index 04c87ec7685e1984006029fa8d27b8d86dcc7696..5467ed5f19278afd266adbfb189e9521b3a13ad0 100644 (file)
--- 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.
+<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/>
 
-**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).
 
index 3513f06f460c7940e24530851ec1bbb636c7d53d..76fa1210e5448c6771d5041bf47c2747d8b2fdcc 100644 (file)
@@ -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",