vue-datocms 5.1.2 → 6.0.0

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
@@ -18,9 +18,12 @@ A set of components and utilities to work faster with [DatoCMS](https://www.dato
18
18
 
19
19
  ## Table of Contents
20
20
 
21
- - [Features](#features)
22
- - [Installation](#installation)
23
- - [Development](#development)
21
+ - [vue-datocms](#vue-datocms)
22
+ - [Table of Contents](#table-of-contents)
23
+ - [Features](#features)
24
+ - [Installation](#installation)
25
+ - [Development](#development)
26
+ - [What is DatoCMS?](#what-is-datocms)
24
27
 
25
28
  ## Features
26
29
 
@@ -28,9 +31,9 @@ A set of components and utilities to work faster with [DatoCMS](https://www.dato
28
31
 
29
32
  [Components](https://vuejs.org/guide/essentials/component-basics.html):
30
33
 
31
- - [`<DatocmsImage />`](src/components/Image)
32
- - [`<DatocmsVideoPlayer />`](src/components/VideoPlayer)
33
- - [`<DatocmsStructuredText />`](src/components/StructuredText)
34
+ - [`<Image />` and `<NakedImage />`](src/components/Image)
35
+ - [`<VideoPlayer />`](src/components/VideoPlayer)
36
+ - [`<StructuredText />`](src/components/StructuredText)
34
37
 
35
38
  [Composables](https://vuejs.org/guide/reusability/composables.html):
36
39
 
@@ -49,26 +52,24 @@ Helpers:
49
52
  npm install vue
50
53
  # Then install vue-datocms
51
54
  npm install vue-datocms
52
- ```
53
- ## Development
54
55
 
55
- This repository contains a number of examples. You can use them to locally test your changes to the package:
56
+ # Demos
56
57
 
57
- - [Vue 3 + TypeScript + Vite](examples/vite-typescript-vue3/) ([running demo](https://vue-datocms-vite-typescript-vue3-example.vercel.app/))
58
- - [Query subscription](examples/query-subscription/) ([running demo](https://vue-datocms-query-subscription-example.vercel.app/))
59
- - [Site search](examples/site-search/) ([running demo](https://vue-datocms-site-search-example.vercel.app/))
58
+ For fully working examples take a look at our [examples directory](https://github.com/datocms/vue-datocms/tree/master/examples).
60
59
 
61
- To use them, follow this recipe starting from the vue-datocms folder:
60
+ Live demo: [https://vue-datocms-example.netlify.com/](https://vue-datocms-example.netlify.com/)
61
+
62
+ ```
63
+ ## Development
64
+
65
+ This repository contains a number of demos/examples. You can use them to locally test your changes.
62
66
 
63
67
  ```bash
64
- npm install
65
- cd examples/vite-typescript-vue3
66
- npm run setup
68
+ cd examples
69
+ npm setup
67
70
  npm run dev
68
71
  ```
69
72
 
70
- It's not recommended to leverage `npm link` to use the working copy from the examples: that would complicate the structure of each example and it would not replicate a real-world installation. Therefore the `npm run setup` available in each example packs and installs the local copy of `vue-datocms` via a `.tgz` compressed tarball.
71
-
72
73
  <!--datocms-autoinclude-footer start-->
73
74
  -----------------
74
75
  # What is DatoCMS?