# Perfect Tense Live Editor

## Install

```bash
npm install --save perfecttense-editor
OR
yarn add perfecttense-editor
```

##Props

| Prop Name    | Required  | Type | Default
| ------------ |:---------:|:--------|:----
| socketUrl    | false | String | `https://io.perfecttense.com`
| onDraftSave  | false | Function | (uid) => {}
| onLoadingStateChanged | false | Function | (bufferSize) => {}
| onGrammarScoreChanged | false | Function | (grammarScore) => {}

## Usage

```jsx
import React, { Component } from 'react'
import PerfectTenseEditor from 'perfecttense-editor'

class Example extends Component {
  render () {
    return (
      <PerfectTenseEditor />
    )
  }
}
```


## Dev Setup

We have our source code for the editor in `src/`, and there are example components in `examples/` that can be used for development purpose. `parcel` is recommended.

Run the following commands from the `root` of the project.

```bash
# create a symlink of the package that can be used in any local project.
yarn link 

# Install dependencies
yarn install

# Start the bundler with watch mode
yarn start
```

Now, go to `examples/parcel` directory(in another tab) and run the following
```bash

# Install dependencies
yarn install

# Symlink previously built dependency for `example` project
yarn link perfecttense-editor

# Start localhost server on port 1234
yarn start
```

## License

MIT © [Cortx]