Skip to content

Commit

Permalink
Standardizing README across DatoCMS public repos
Browse files Browse the repository at this point in the history
  • Loading branch information
arcataroger authored Dec 20, 2023
1 parent e780b04 commit f82e747
Showing 1 changed file with 33 additions and 6 deletions.
39 changes: 33 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<!--datocms-autoinclude-header start-->
<a href="https://www.datocms.com/"><img src="https://www.datocms.com/images/full_logo.svg" height="60"></a>

👉 [Visit the DatoCMS homepage](https://www.datocms.com) or see [What is DatoCMS?](#what-is-datocms)
<!--datocms-autoinclude-header end-->

# vue-datocms

![MIT](https://img.shields.io/npm/l/vue-datocms?style=for-the-badge) ![NPM](https://img.shields.io/npm/v/vue-datocms?style=for-the-badge) [![Build Status](https://img.shields.io/github/actions/workflow/status/datocms/vue-datocms/node.js.yml?branch=master&style=for-the-badge)](https://github.com/datocms/vue-datocms/actions/workflows/node.js.yml)
Expand All @@ -10,12 +16,6 @@ A set of components and utilities to work faster with [DatoCMS](https://www.dato
- Usable both client and server side;
- Compatible with vanilla Vue and pretty much any other Vue-based solution.

<br /><br />
<a href="https://www.datocms.com/">
<img src="https://www.datocms.com/images/full_logo.svg" height="60">
</a>
<br /><br />

## Table of Contents

- [Features](#features)
Expand Down Expand Up @@ -67,3 +67,30 @@ npm run dev
```

Due to the way Vue and VueDemi work, 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.

<!--datocms-autoinclude-footer start-->
-----------------
# What is DatoCMS?
<a href="https://www.datocms.com/"><img src="https://www.datocms.com/images/full_logo.svg" height="60"></a>

[DatoCMS](https://www.datocms.com/) is the REST & GraphQL Headless CMS for the modern web.

Trusted by over 25,000 enterprise businesses, agency partners, and individuals across the world, DatoCMS users create online content at scale from a central hub and distribute it via API. We ❤️ our [developers](https://www.datocms.com/team/best-cms-for-developers), [content editors](https://www.datocms.com/team/content-creators) and [marketers](https://www.datocms.com/team/cms-digital-marketing)!

**Quick links:**

- ⚡️ Get started with a [free DatoCMS account](https://dashboard.datocms.com/signup)
- 🔖 Go through the [docs](https://www.datocms.com/docs)
- ⚙️ Get [support from us and the community](https://community.datocms.com/)
- 🆕 Stay up to date on new features and fixes on the [changelog](https://www.datocms.com/product-updates)

**Our featured repos:**
- [datocms/react-datocms](https://github.com/datocms/react-datocms): React helper components for images, Structured Text rendering, and more
- [datocms/js-rest-api-clients](https://github.com/datocms/js-rest-api-clients): Node and browser JavaScript clients for updating and administering your content. For frontend fetches, we recommend using our [GraphQL Content Delivery API](https://www.datocms.com/docs/content-delivery-api) instead.
- [datocms/cli](https://github.com/datocms/cli): Command-line interface that includes our [Contentful importer](https://github.com/datocms/cli/tree/main/packages/cli-plugin-contentful) and [Wordpress importer](https://github.com/datocms/cli/tree/main/packages/cli-plugin-wordpress)
- [datocms/plugins](https://github.com/datocms/plugins): Example plugins we've made that extend the editor/admin dashboard
- [datocms/gatsby-source-datocms](https://github.com/datocms/gatsby-source-datocms): Our Gatsby source plugin to pull data from DatoCMS
- Frontend examples in different frameworks: [Next.js](https://github.com/datocms/nextjs-demo), [Vue](https://github.com/datocms/vue-datocms) and [Nuxt](https://github.com/datocms/nuxtjs-demo), [Svelte](https://github.com/datocms/datocms-svelte) and [SvelteKit](https://github.com/datocms/sveltekit-demo), [Astro](https://github.com/datocms/datocms-astro-blog-demo), [Remix](https://github.com/datocms/remix-example). See [all our starter templates](https://www.datocms.com/marketplace/starters).

Or see [all our public repos](https://github.com/orgs/datocms/repositories?q=&type=public&language=&sort=stargazers)
<!--datocms-autoinclude-footer end-->

4 comments on commit f82e747

@vercel
Copy link

@vercel vercel bot commented on f82e747 Dec 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

vue-datocms-site-search-example – ./examples/site-search

vue-datocms-site-search-example.vercel.app
vue-datocms-site-search-example-datocms.vercel.app
vue-datocms-site-search-example-git-master-datocms.vercel.app

@vercel
Copy link

@vercel vercel bot commented on f82e747 Dec 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

vue-datocms-vite-typescript-vue3-example – ./examples/vite-typescript-vue3

vue-datocms-vite-typescript-vue3-example.vercel.app
vue-datocms-vite-typescript-vue3-example-datocms.vercel.app
vue-datocms-vite-typescript-vue3-example-git-master-datocms.vercel.app

@vercel
Copy link

@vercel vercel bot commented on f82e747 Dec 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

vue-datocms-vue-cli-babel-javascript-vue2-example – ./examples/vue-cli-babel-javascript-vue2

vue-datocms-vue-cli-babel-javascript-vue2-example-datocms.vercel.app
vue-datocms-vue-cli-babel-javascript-vue2-example.vercel.app
vue-datocms-vue-cli-babel-javascript-vue2-ex-git-00872c-datocms.vercel.app

@vercel
Copy link

@vercel vercel bot commented on f82e747 Dec 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

vue-datocms-query-subscription-example – ./examples/query-subscription

vue-datocms-query-subscription-example-git-master-datocms.vercel.app
vue-datocms-query-subscription-example-datocms.vercel.app
vue-datocms-query-subscription-example.vercel.app

Please sign in to comment.