@prismicio/vue - npm Package Compare versions

Comparing version 3.0.0-alpha.2 to 3.0.0-alpha.3

package.json

 {
 	"name": "@prismicio/vue",
-	"version": "3.0.0-alpha.2",
+	"version": "3.0.0-alpha.3",
 	"description": "Vue plugin, components, and composables to fetch and present Prismic content",
@@ -5,0 +5,0 @@ "keywords": [

README.md

 # @prismicio/vue
 
-[WIP]
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
+[![Codecov][codecov-src]][codecov-href]
+[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
+[![License][license-src]][license-href]
 
+<!-- TODO: Replacing link to Prismic with [Prismic][prismic] is useful here -->
+
+[Vue][vue] plugin, components, and composables to fetch and present [Prismic][prismic] content.
+
+- 📝 &nbsp;Display content from Prismic like [Rich Text][prismic-rich-text] and [Link][prismic-link] fields;
+- 🍡 &nbsp;Render Prismic [Slice Zones][prismic-slices] declaratively with Vue components;
+- 🎣 &nbsp;Fetch Prismic content using Vue [composition API][composition-api] or [options-api].
+
+## Install
+
+```bash
+npm install @prismicio/vue
+```
+
+## Documentation
+
+To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].
+
+## Contributing
+
+Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!
+
+**Asking a question**: [Open a new topic][forum-question] on our community forum explaining what you want to achieve / your question. Our support team will get back to you shortly.
+
+**Reporting a bug**: [Open an issue][repo-bug-report] explaining your application's setup and the bug you're encountering.
+
+**Suggesting an improvement**: [Open an issue][repo-feature-request] explaining your improvement or feature so we can discuss and learn more.
+
+**Submitting code changes**: For small fixes, feel free to [open a PR][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.
+
 ## License
@@ -22,1 +57,38 @@
 ```
+
+<!-- Links -->
+
+[prismic]: https://prismic.io
+
+<!-- TODO: Replace link with a more useful one if available -->
+
+[prismic-docs]: https://prismic.io/docs/technologies/vuejs
+[changelog]: ./CHANGELOG.md
+[vue]: https://v3.vuejs.org
+[prismic-rich-text]: https://prismic.io/docs/core-concepts/rich-text-title
+[prismic-link]: https://prismic.io/docs/core-concepts/link-content-relationship
+[prismic-slices]: https://prismic.io/docs/core-concepts/slices
+[vue-composition]: https://v3.vuejs.org/guide/composition-api-introduction.html
+[vue-options]: https://v3.vuejs.org/guide/introduction.html
+
+<!-- TODO: Replace link with a more useful one if available -->
+
+[forum-question]: https://community.prismic.io/c/kits-and-dev-languages/vue-js/16
+[repo-bug-report]: https://github.com/prismicio/prismic-vue/issues/new?assignees=&labels=bug&template=bug_report.md&title=
+[repo-feature-request]: https://github.com/prismicio/prismic-vue/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
+[repo-pull-requests]: https://github.com/prismicio/prismic-vue/pulls
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@prismicio/vue/latest.svg
+[npm-version-href]: https://npmjs.com/package/@prismicio/vue
+[npm-downloads-src]: https://img.shields.io/npm/dm/@prismicio/vue.svg
+[npm-downloads-href]: https://npmjs.com/package/@prismicio/vue
+[github-actions-ci-src]: https://github.com/prismicio/prismic-vue/workflows/ci/badge.svg
+[github-actions-ci-href]: https://github.com/prismicio/prismic-vue/actions?query=workflow%3Aci
+[codecov-src]: https://img.shields.io/codecov/c/github/prismicio/prismic-vue.svg
+[codecov-href]: https://codecov.io/gh/prismicio/prismic-vue
+[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
+[conventional-commits-href]: https://conventionalcommits.org
+[license-src]: https://img.shields.io/npm/l/@prismicio/vue.svg
+[license-href]: https://npmjs.com/package/@prismicio/vue

src/components/PrismicEmbed.ts

@@ -39,3 +39,3 @@ import {
  */
-export const PrismicEmbedImpl = defineComponent({
+export const PrismicEmbedImpl = /*#__PURE__*/ defineComponent({
 	name: "PrismicEmbed",
@@ -42,0 +42,0 @@ props: {

src/components/PrismicImage.ts

@@ -68,3 +68,3 @@ import {
  */
-export const PrismicImageImpl = defineComponent({
+export const PrismicImageImpl = /*#__PURE__*/ defineComponent({
 	name: "PrismicImage",
@@ -71,0 +71,0 @@ props: {

src/components/PrismicLink.ts

@@ -190,3 +190,3 @@ import {
  */
-export const PrismicLinkImpl = defineComponent({
+export const PrismicLinkImpl = /*#__PURE__*/ defineComponent({
 	name: "PrismicLink",
@@ -193,0 +193,0 @@ props: {

src/components/PrismicRichText.ts

@@ -179,3 +179,3 @@ import {
  */
-export const PrismicRichTextImpl = defineComponent({
+export const PrismicRichTextImpl = /*#__PURE__*/ defineComponent({
 	name: "PrismicRichText",
@@ -182,0 +182,0 @@ props: {

src/components/PrismicText.ts

@@ -87,3 +87,3 @@ import {
  */
-export const PrismicTextImpl = defineComponent({
+export const PrismicTextImpl = /*#__PURE__*/ defineComponent({
 	name: "PrismicText",
@@ -90,0 +90,0 @@ props: {

src/components/SliceZone.ts

@@ -177,3 +177,3 @@ import {
 	? ((() => null) as FunctionalComponent<SliceComponentProps>)
-	: (defineComponent({
+	: /*#__PURE__*/ (defineComponent({
 			name: "TODOSliceCOmponent",
@@ -324,3 +324,3 @@ props: getSliceComponentProps(),
  */
-export const SliceZoneImpl = defineComponent({
+export const SliceZoneImpl = /*#__PURE__*/ defineComponent({
 	name: "SliceZone",
@@ -327,0 +327,0 @@ props: {

No alert changes

Improved metrics

Total package byte prevSize

188166

increased by2.28%

Number of lines in readme file

94

increased by327.27%

No dependency changes