Skip to content

Commit

Permalink
docs: Update README (#146)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoseZapata3 authored Sep 5, 2024
1 parent f674201 commit 331cfaa
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,7 @@
[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6469/badge)](https://bestpractices.coreinfrastructure.org/projects/6469)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/kommitters/editorjs-inline-image/badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/editorjs-inline-image)


Image tool for [Editor.js](https://editorjs.io).

Embed images from [Unsplash](https://unsplash.com/), blob or URLs.

Image tool for [Editor.js](https://editorjs.io) that enables you to embed images from [Unsplash](https://unsplash.com/), blobs, or URLs directly into your content.
![](assets/demo.gif)

## Notes
Expand All @@ -23,6 +19,8 @@ Extends the functionality of [simple-image](https://github.com/editor-js/simple-

## Installation

You can install the tool via npm or load it from a CDN.

### Install via NPM
Get the package
```shell
Expand Down Expand Up @@ -75,7 +73,7 @@ const editor = EditorJS({
| Field | Type | Description |
| -------------- | --------- | ------------------------------- |
| embed | `{display: boolean}` | You could display or not the embed tab, If you don't fill the embed config by default the value is set on `true`. |
| unsplash | `{appName: string, apiUrl: string, maxResults: string}` | Config for **Unsplash API**. Contains 3 fields: <br><br> **appName**: Unsplash `Application Name`. <br><br> **apiUrl**: URL of the Proxy for Unsplash API. <br><br> **maxResults**: Max number of images per search (default 30). |
| unsplash | `{appName: string, apiUrl: string, maxResults: Number}` | Config for **Unsplash API**. Contains 3 fields: <br><br> **appName**: Unsplash `Application Name`. <br><br> **apiUrl**: URL of the Proxy for Unsplash API. <br><br> **maxResults**: Max number of images per search (default 30). |

## Tool's tunes

Expand Down

0 comments on commit 331cfaa

Please sign in to comment.