Skip to content
This repository was archived by the owner on May 31, 2020. It is now read-only.

Commit 7fb581c

Browse files
committed
docs(atomic-block): update docs for atomic-block
1 parent 0bdb8c6 commit 7fb581c

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

packages/atomic-block/README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
1-
# djs@atomic-block - Not released, please use with caution ;)
1+
# @djsp/atomic-block
22

33
![file size](http://img.badgesize.io/https://unpkg.com/@djsp/atomic-block/dist/index.js?label=size&style=flat-square)
44
[![NPM](https://img.shields.io/npm/v/@djsp/atomic-block.svg)](https://www.npmjs.com/package/@djsp/atomic-block) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
55

6+
## Installation
67

7-
Example:
8+
`@djsp/atomic-block` depends on `@djsp/utils` which must also be installed.
9+
10+
```sh
11+
npm install --save @djsp/utils @djsp/atomic-block
12+
# or alternately
13+
yarn add @djsp/utils @djsp/atomic-block
14+
```
15+
16+
## Usage
817

918
```jsx
1019
<EditorContainer>
@@ -19,3 +28,6 @@ Example:
1928
</AtomicBlock>
2029
</EditorContainer>
2130
```
31+
32+
## Examples
33+
- [Editor with image](https://codesandbox.io/s/github/draft-js-plugins/next/tree/master/examples/atomic-block)

0 commit comments

Comments
 (0)