react-transcriber
v1.0.0
Published
React Transcriber
Downloads
3
Readme
React Transcriber
Speech transcription component for React. Allows for simple speech to text, and can use a database to transcribe the results. Because Speech Recognition is only available in Webkit, this component is only compatible with Chrome and Opera.
Demo & Examples
Live demo: kremonte.github.io/react-transcriber
To build the examples locally, run:
npm install
npm start
Then open localhost:8000
in a browser.
Installation
The easiest way to use react-transcriber is to install it from NPM and include it in your own React build process (using Webpack, Browserify, etc).
You can also use the standalone build by including dist/react-transcriber.js
in your page. If you use this, make sure you have already included React, and it is available as a global variable.
npm install react-transcriber --save
Usage
var ReactTranscriber = require('react-transcriber');
<ReactTranscriber>Example</ReactTranscriber>
Properties
prop|type|description ----|----|-----------
Notes
ADDITIONAL USAGE NOTES
Development (src
, lib
and the build process)
NOTE: The source code for the component is in src
. A transpiled CommonJS version (generated with Babel) is available in lib
for use with node.js, browserify and webpack. A UMD bundle is also built to dist
, which can be included without the need for any build system.
To build, watch and serve the examples (which will also watch the component source), run npm start
. If you just want to watch changes to src
and rebuild lib
, run npm run watch
(this is useful if you are working with npm link
).
License
PUT LICENSE HERE
Copyright (c) 2015 Dan Rouse.