docs

packages/api/README.md

@@ -1,11 +1,10 @@
-# `api`
+# `@mayas/cld-api`
 
-> TODO: description
+> More friendly API Wrapper for Cloudinary
 
 ## Usage
 
-```
-const api = require('api');
+```js
+const api = require('@mayas/cld-api');
 
-// TODO: DEMONSTRATE API
 ```

packages/api/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mayas/cld-api",
   "version": "0.0.6",
-  "description": "> TODO: description",
+  "description": "More friendly API Wrapper for Cloudinary Node.js",
   "author": "Maya Shavin <maya@cloudinary.com>",
   "homepage": "https://github.com/mayashavin/gridsome-plugin-cloudinary/tree/master/packages/api#readme",
   "license": "MIT",
@@ -29,14 +29,10 @@
   },
   "dependencies": {
     "@babel/cli": "^7.12.1",
-    "@cloudinary/base": "^1.0.0-alpha.2",
     "chalk": "^4.1.0",
     "cloudinary": "^1.23.0",
     "consola": "^2.15.0",
-    "lodash.compact": "^3.0.1",
-    "lodash.snakecase": "^4.1.1",
-    "webpack-bundle-analyzer": "^3.9.0",
-    "webpack-cli": "^4.1.0"
+    "lodash.snakecase": "^4.1.1"
   },
   "devDependencies": {
     "eslint": "^7.11.0",

packages/demo/package.json

@@ -1,11 +1,13 @@
 {
   "name": "demo",
   "version": "0.0.6",
+  "description": "Demo application for all the plugins of Cloudinary for Gridsome",
   "scripts": {
     "build": "gridsome build",
     "develop": "gridsome develop",
     "explore": "gridsome explore"
   },
+  "keywords": ["cloudinary", "gridsome", "image", "optimization", "demo"],
   "dependencies": {
     "@cloudinary/base": "^1.0.0-alpha.2",
     "@gridsome/source-filesystem": "^0.6.2",

packages/gs-cld-plugin/README.md

@@ -1,11 +1,21 @@
-# `gs-cld-transformer`
+# `@mayas/gridsome-plugin-cld`
 
-> TODO: description
+> Cloudinary plugin for Gridsome
 
 ## Usage
 
-```
-const gsCldTransformer = require('gs-cld-transformer');
-
-// TODO: DEMONSTRATE API
+```js
+/*gridsome.config.js*/
+export default {
+  plugins: [
+    {
+      use: "@mayas/gridsome-plugin-cld",
+      options: {
+        cloudName: process.env.CLOUDNAME,
+        apiKey: process.env.API_KEY,
+        apiSecret: process.env.API_SECRET,
+      }
+    },
+  ]
+}
 ```

packages/gs-cld-source/README.md

@@ -1,9 +1,37 @@
 # `@mayas/gridsome-source-cld`
 
-> TODO: description
+> Cloudinary Source plugin for Gridsome
 
 ## Installation
 
 ```bash
 yarn add @mayas/gridsome-source-cld
 ```
+
+## Usage
+
+```js
+export default {
+  plugins: [
+    {
+      use: '@mayas/gridsome-source-cld',
+      options: {
+        cloudName: process.env.CLOUDNAME,
+        apiKey: process.env.API_KEY,
+        apiSecret: process.env.API_SECRET,
+        resourceOptions: {
+          type: "upload",
+          prefix: 'examples',
+          max_results: 50
+        },
+        // transformations: {
+        //   width: 200,
+        //   height: 200,
+        //   gravity: 'auto:subject',
+        //   crop: 'fill',
+        // }
+      },
+    },
+  ]
+}
+```

packages/gs-cld-source/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mayas/gridsome-source-cld",
   "version": "0.0.6",
-  "description": "Source plugin",
+  "description": "Source plugin of Cloudinary for Gridsome",
   "keywords": [
     "gridsome",
     "cloudinary",

packages/gs-image-node/README.md

@@ -1,6 +1,6 @@
 # `gs-image-node`
 
-> TODO: description
+> WIP - Please do not use
 
 ## Usage
 

packages/gs-transformer-image/README.md

@@ -1,11 +1,23 @@
 # `gridsome-transformer-image`
 
-> TODO: description
+> Image transformer for Gridsome
 
 ## Usage
 
-```
-const gridsomeTransformerImage = require('gridsome-transformer-image');
-
-// TODO: DEMONSTRATE API
+```js
+export default {
+  transformers: {
+    image: {
+      uploadOptions: {
+        folder: 'examples',
+      },
+      loader: {
+        type: 'cloudinary',
+        cloudName: process.env.CLOUDNAME,
+        apiKey: process.env.API_KEY,
+        apiSecret: process.env.API_SECRET,
+      }
+    }
+  }
+}
 ```

stats.json

@@ -0,0 +1,3 @@
+Installing 'webpack-cli' (running 'yarn add -D webpack-cli')...
+yarn add v1.22.10
+info Visit https://yarnpkg.com/en/docs/cli/add for documentation about this command.