fix(docs): improve getting started a bit more

sanscheese · Nov 28, 2019 · 1b8190a · 1b8190a
1 parent f8b5dc4
commit 1b8190a
Show file tree

Hide file tree

Showing 3 changed files with 1,771 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -58,20 +58,22 @@ module.exports = {
 
 Add the `CraftLivePreview` component to you build.
 
-[Override `App.vue`](https://gridsome.org/docs/overriding-app/)
+Override `App.vue` - [See Gridsome docs](https://gridsome.org/docs/overriding-app/)
 
 ```html
 <template>
+  <!-- ... -->
   <CraftLivePreview endpoint="https://example.com/api" />
+  <!-- ... -->
 </template>
 
 <script>
-import CraftLivePreview from '@bhws/gridsome-source-craft-graphql/CraftLivePreview'
-
 export default {
+  //...
   components: {
-    CraftLivePreview
+    CraftLivePreview: () => imoprt ('@bhws/gridsome-source-craft-graphql/CraftLivePreview')
   }
+  //...
 }
 </script>
 ```

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "version": "0.0.2",
-  "name": "@bhws/source-craft-graphql",
+  "name": "@bhws/gridsome-source-craft-graphql",
   "description": "Craft CMS (GraphQL) source for Gridsome",
   "homepage": "https://github.com/sanscheese/gridsome-source-craft-graphql/",
   "author": "Ben Sheedy <[email protected]> (http://bensheedy.com/)",