Skip to content

Commit

Permalink
Update Readme and changelog to reflect changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
OtherCroissant authored and abhaynikam committed Dec 2, 2020
1 parent 327a2ec commit eea5e5e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Change log

## master (unreleased)
* Remove 'unused' import of Trix to prevent webpack packaging conflicts with projects.
* Support ID and Name input attribute as component props.

## 1.0.6 (17-September-2020)

Expand Down
5 changes: 5 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ yarn add react-trix-rte

```javascript
import React, { useState } from "react";
import Trix from "trix";
import { ReactTrixRTEInput } from "react-trix-rte";

export default function TrixEditor(props) {
Expand All @@ -53,6 +54,8 @@ export default function TrixEditor(props) {

| Name | Type | Description |
| ------------------- | ---- | ----------- |
| id | string | The HTML id attribute for the input field
| name | string | The HTML name attribute for the input field
| toolbarId | string | If a custom toolbar is used for the Trix Input, pass the `toolbarId` of the custom toolbar to the input. |
| isRailsDirectUpload | boolean | React Trix editor support direct uploading of the files to the service if you are using Rails as a backend server. This defaults to `false` |
| placeholder | string | Adds a placeholder to the React Trix Input |
Expand Down Expand Up @@ -83,6 +86,7 @@ export default function TrixEditor(props) {

```javascript
import React, { useState } from "react";
import Trix from "trix";
import { ReactTrixRTEInput, ReactTrixRTEToolbar } from "react-trix-rte";

export default function TrixEditor(props) {
Expand Down Expand Up @@ -111,6 +115,7 @@ Read more about [contributing](https://github.com/abhaynikam/react-trix-rte/blob

### Author
[Abhay Nikam](https://www.abhaynikam.me/pages/about)
[CUnknown](https://github.com/CUnknown)

### License
This project is licensed under the [MIT License](https://github.com/abhaynikam/react-trix-rte/blob/7704eb681801fe2eacd00a5da50cd0bfb8c0238d/LICENSE)

0 comments on commit eea5e5e

Please sign in to comment.