Skip to content

Commit f946cc2

Browse files
committed
updated Readme
1 parent 15d4586 commit f946cc2

File tree

2 files changed

+34
-10
lines changed

2 files changed

+34
-10
lines changed

README.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,37 @@
1-
This project was bootstrapped with [Create Contentful App](https://github.com/contentful/create-contentful-app).
1+
# Contentful Ingredients Field App
22

3-
## Available Scripts
3+
This [Contentful App](https://www.contentful.com/developers/docs/extensibility/app-framework/) adds a custom UI that can be used on top of the [JSON Object](https://www.contentful.com/developers/docs/concepts/data-model/) field type and represents a list of ingredients for recipes.
4+
5+
![](./assets/contentful-ingredients-field-demo.gif)
6+
7+
Inspired by [this video](https://www.youtube.com/watch?v=OtmV3TPTbRs) and bootstrapped with [Create Contentful App](https://github.com/contentful/create-contentful-app).
8+
9+
## Data structure
10+
11+
The data produced by the ingredients field type looks like this:
12+
13+
```json
14+
[
15+
{
16+
"amount": "2 tbsp",
17+
"id": "4skkkYCvbdHVhRfI5hdW7o"
18+
},
19+
{
20+
"amount": "3 tsp",
21+
"id": "2xFnDNGBloZzp59kddJBI6"
22+
},
23+
{
24+
"amount": "200g",
25+
"id": "2uqKK4iWHxhlRrGn24OLvy"
26+
}
27+
]
28+
```
29+
30+
`id` represents a relation to an entry of a collection named `"ingredients"`.
31+
32+
`amount` is an unformatted string holding information about how much to use of the referenced ingredient.
33+
34+
## Development
435

536
In the project directory, you can run:
637

@@ -20,14 +51,7 @@ It correctly bundles React in production mode and optimizes the build for the be
2051
The build is minified and the filenames include the hashes.
2152
Your app is ready to be deployed!
2253

23-
## Libraries to use
24-
25-
To make your app look and feel like Contentful use the following libraries:
26-
27-
- [Forma 36](https://f36.contentful.com/) – Contentful's design system
28-
- [Contentful Field Editors](https://www.contentful.com/developers/docs/extensibility/field-editors/) – Contentful's field editor React components
29-
30-
## Learn More
54+
## More about Contentful Apps
3155

3256
[Read more](https://www.contentful.com/developers/docs/extensibility/app-framework/create-contentful-app/) and check out the video on how to use the CLI.
3357

2.97 MB
Loading

0 commit comments

Comments
 (0)