Skip to content

Commit 8318c44

Browse files
committed
updated documentation; added cover and preview
1 parent 7cf7b85 commit 8318c44

File tree

4 files changed

+56
-23
lines changed

4 files changed

+56
-23
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
11
# Raster Dato Plugin
22

33
Getting images from Raster and use them in your DatoCMS project.
4+
5+
![Raster Dato Plugin Preview](docs/preview.png)
6+
7+
## Preparing to Use the Raster App in Contentful
8+
9+
Before using the app in Contentful an API key is needed, along with your Organization’s ID.
10+
11+
### Getting the Organization ID
12+
13+
To use the Raster app in Contentful, an Organization ID is required. You can get the Organization ID by navigating to `Organization name` `>` `Settings`. The Organization ID is the slug found after the [raster.app](http://raster.app/) URL.
14+
15+
## API Key
16+
17+
Similar to a required Organization ID, the Raster app in Contentful also needs an API Key. You can set up the API key and enable library level access by navigating to `Organization name` `>` `Settings`.
18+
19+
To enable APIs, follow these steps:
20+
21+
1. Generate a new key.
22+
2. Enable `Read` access for the libraries you want to access via the API key.
23+
3. Save your changes.

docs/cover.png

591 KB
Loading

docs/preview.png

2.08 MB
Loading

package.json

Lines changed: 36 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
11
{
22
"name": "raster-dato-plugin",
33
"version": "0.1.0",
4-
"private": true,
5-
"dependencies": {
6-
"@dnd-kit/core": "^6.1.0",
7-
"@dnd-kit/sortable": "^8.0.0",
8-
"@types/node": "^18.11.18",
9-
"@types/react": "^18.3.3",
10-
"@types/react-dom": "^18.3.0",
11-
"clsx": "^2.1.1",
12-
"datocms-plugin-sdk": "^1.1.0",
13-
"datocms-react-ui": "^1.1.0",
14-
"lodash": "^4.17.21",
15-
"react": "^18.3.1",
16-
"react-dom": "^18.3.1",
17-
"react-scripts": "5.0.1",
18-
"sass": "^1.77.8",
19-
"swr": "^2.2.5",
20-
"typescript": "^5.5.3",
21-
"zustand": "^4.5.4"
22-
},
4+
"author": "Raster <hello@raster.app>",
5+
"license": "MIT",
6+
"description": "A DatoCMS plugin for Raster, a digital asset manager for modern teams, saving time organizing, editing, and hosting photography.",
7+
"homepage": "https://raster.app",
8+
"repository": "https://github.com/raster-app/raster-dato-plugin",
9+
"keywords": [
10+
"datocms-plugin",
11+
"raster",
12+
"raster-app",
13+
"dato",
14+
"plugin",
15+
"dam",
16+
"digital-asset-management"
17+
],
2318
"scripts": {
2419
"start": "cross-env BROWSER='none' PUBLIC_URL='/' react-scripts start",
2520
"build": "cross-env PUBLIC_URL='.' react-scripts build",
@@ -44,6 +39,24 @@
4439
"last 1 safari version"
4540
]
4641
},
42+
"dependencies": {
43+
"@dnd-kit/core": "^6.1.0",
44+
"@dnd-kit/sortable": "^8.0.0",
45+
"@types/node": "^18.11.18",
46+
"@types/react": "^18.3.3",
47+
"@types/react-dom": "^18.3.0",
48+
"clsx": "^2.1.1",
49+
"datocms-plugin-sdk": "^1.1.0",
50+
"datocms-react-ui": "^1.1.0",
51+
"lodash": "^4.17.21",
52+
"react": "^18.3.1",
53+
"react-dom": "^18.3.1",
54+
"react-scripts": "5.0.1",
55+
"sass": "^1.77.8",
56+
"swr": "^2.2.5",
57+
"typescript": "^5.5.3",
58+
"zustand": "^4.5.4"
59+
},
4760
"devDependencies": {
4861
"@monogram/prettier-config": "^0.3.4",
4962
"@types/lodash": "^4.17.7",
@@ -53,10 +66,10 @@
5366
"tailwindcss": "^3.4.7"
5467
},
5568
"datoCmsPlugin": {
56-
"title": "",
57-
"previewImage": "",
58-
"coverImage": "",
69+
"title": "Raster DatoCMS Plugin",
70+
"coverImage": "docs/cover.png",
71+
"previewImage": "docs/preview.png",
5972
"entryPoint": "build/index.html"
6073
},
6174
"prettier": "@monogram/prettier-config"
62-
}
75+
}

0 commit comments

Comments
 (0)