diff --git a/README.md b/README.md index 22d95d8..70f0042 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# DruxtSite quickstart - Drupal +# DruxtSite quickstart - Drupal with Tome sync -[![CircleCI](https://dl.circleci.com/status-badge/img/gh/druxt/quickstart-druxt-site/tree/develop.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/druxt/quickstart-druxt-site/tree/develop) +[![CircleCI](https://dl.circleci.com/status-badge/img/gh/druxt/quickstart-druxt-site-tome/tree/develop.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/druxt/quickstart-druxt-site-tome/tree/develop) > One click, Fully Decoupled Drupal Site starter-kit with Druxt. DruxtSite connects Drupal to Nuxt via JSON:API to provide a framework for building a Fully Decoupled site. This repostory provides a quickstart installation of: -- Drupal 9 +- Drupal 9 with Tome sync - Nuxt 2 - DruxtSite - DruxtAuth @@ -18,7 +18,7 @@ This repostory provides a quickstart installation of: Try it before you fork it: -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/druxt/quickstart-druxt-site) +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/druxt/quickstart-druxt-site-tome) ## Getting started @@ -29,7 +29,7 @@ Try it before you fork it: 2. Clone the repository locally. - Example: `git clone git@github.com:druxt/quickstart-druxt-site.git` + Example: `git clone git@github.com:druxt/quickstart-druxt-site-tome.git` 3. Setup an `.env` file and update as required: `cp .env.example .env` @@ -62,7 +62,7 @@ Try it before you fork it: 2. Once the repository has been generated, open it in Gitpod by appending `https://gitpod.io#` to the GitHub url. - Example: `https://gitpod.io#github.com/druxt/quickstart-druxt-site` + Example: `https://gitpod.io#github.com/druxt/quickstart-druxt-site-tome` _Note:_ If this is your first time using Gitpod, you can signup for a free plan with your Github account. @@ -73,7 +73,7 @@ Try it before you fork it: ## How to use it -Your environment contains a pre-install, pre-configured and running instance of Drupal and Nuxt, with the DruxtSite module enabled. +Your environment contains a pre-install, pre-configured and running instance of Drupal with Tome, and Nuxt with the DruxtSite module enabled. You can access the services in your browser, via the **Remote Explorer** extension, or via the URL pattern: `https://[PORT]-[GITPOD_ID].[GITPOD_SERVER].gitpod.io` @@ -120,6 +120,13 @@ Druxt integrates with the Nuxt Storybook module to provide zero-configuration, a To start Storybook, navigate to the `nuxt` directory and run `npx nuxt storybook`. +### Tome sync + +Tome sync is a static storage system for content, allowing you to keep your content up to date without the need of a database. + +See the project page for more details: https://www.drupal.org/project/tome + + ## License [MIT](https://github.com/druxt/druxt.js/blob/develop/LICENSE)