pangea-lib 1.16.14 → 1.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1 +1,34 @@
1
- # PANGEA
1
+ # Pangea
2
+
3
+ ## Setup
4
+
5
+ Install the following package in your project with npm or yarn:
6
+
7
+ ```bash
8
+ 1. yarn add pangea-lib
9
+ 2. yarn add pinia
10
+ 3. yarn add pinia-plugin-persistedstate
11
+ ```
12
+
13
+ Configure the following in your `main.js`:
14
+
15
+ ```javascript
16
+ import { createApp } from 'vue';
17
+ import App from '@/App.vue';
18
+ // pinia
19
+ import { createPinia } from 'pinia';
20
+ import { createPersistedState } from 'pinia-plugin-persistedstate';
21
+ // pangea
22
+ import pangea from 'pangea-lib';
23
+
24
+ // create app
25
+ const app = createApp(App);
26
+ // pinia
27
+ const pinia = createPinia();
28
+ pinia.use(createPersistedState({ storage: localStorage }));
29
+ app.use(pinia);
30
+ // pangea
31
+ app.use(pangea);
32
+ // mount
33
+ app.mount('#app');
34
+ ```