-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5c01092
Showing
15 changed files
with
134,189 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# This file is for unifying the coding style for different editors and IDEs | ||
# editorconfig.org | ||
root = true | ||
|
||
[*] | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = false | ||
insert_final_newline = true | ||
indent_style = tab | ||
|
||
[*.json] | ||
indent_style = space | ||
indent_size = 2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
.publish/* | ||
dist/* | ||
example/dist/* | ||
lib/* | ||
node_modules/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{ | ||
"parser": "babel-eslint", | ||
"env": { | ||
"browser": true, | ||
"node": true | ||
}, | ||
"plugins": [ | ||
"react" | ||
], | ||
"rules": { | ||
"curly": [2, "multi-line"], | ||
"quotes": [2, "single", "avoid-escape"], | ||
"react/display-name": 0, | ||
"react/jsx-boolean-value": 1, | ||
"react/jsx-quotes": 1, | ||
"react/jsx-no-undef": 1, | ||
"react/jsx-sort-props": 0, | ||
"react/jsx-sort-prop-types": 1, | ||
"react/jsx-uses-react": 1, | ||
"react/jsx-uses-vars": 1, | ||
"react/no-did-mount-set-state": 1, | ||
"react/no-did-update-set-state": 1, | ||
"react/no-multi-comp": 1, | ||
"react/no-unknown-property": 1, | ||
"react/prop-types": 1, | ||
"react/react-in-jsx-scope": 1, | ||
"react/self-closing-comp": 1, | ||
"react/wrap-multilines": 1, | ||
"semi": 2, | ||
"strict": 0 | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Logs | ||
logs | ||
*.log | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
|
||
# Coverage tools | ||
lib-cov | ||
coverage | ||
coverage.html | ||
.cover* | ||
|
||
# Dependency directory | ||
node_modules | ||
|
||
# Example build directory | ||
example/dist | ||
.publish | ||
|
||
# Editor and other tmp files | ||
*.swp | ||
*.un~ | ||
*.iml | ||
*.ipr | ||
*.iws | ||
*.sublime-* | ||
.idea/ | ||
*.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# 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](http://kremonte.github.io/react-transcriber/) | ||
|
||
To build the examples locally, run: | ||
|
||
``` | ||
npm install | ||
npm start | ||
``` | ||
|
||
Then open [`localhost:8000`](http://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](http://webpack.github.io/), [Browserify](http://browserify.org), 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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
{ | ||
"name": "react-transcriber", | ||
"version": "0.0.0", | ||
"description": "React Transcriber", | ||
"main": "dist/react-transcriber.min.js", | ||
"homepage": "https://github.com/kremonte/react-transcriber", | ||
"authors": [ | ||
"Dan Rouse" | ||
], | ||
"moduleType": [ | ||
"amd", | ||
"globals", | ||
"node" | ||
], | ||
"keywords": [ | ||
"react", | ||
"react-component" | ||
], | ||
"license": "MIT", | ||
"ignore": [ | ||
".editorconfig", | ||
".gitignore", | ||
"package.json", | ||
"src", | ||
"node_modules", | ||
"example", | ||
"test" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
## This file is here to ensure it is included in the gh-pages branch, | ||
## when `gulp deploy` is used to push updates to the demo site. | ||
|
||
# Dependency directory | ||
node_modules |
Oops, something went wrong.