Restore license & readme

This commit is contained in:
Kevin van Zonneveld 2015-11-17 14:56:00 +01:00
parent 75104ddd4e
commit 78f8258fa1
2 changed files with 53 additions and 0 deletions

19
LICENSE Normal file
View file

@ -0,0 +1,19 @@
Copyright (c) 2015 Transloadit
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

34
README.md Normal file
View file

@ -0,0 +1,34 @@
# transloadit-js-client
A work in progress - nothing to see here.
## Design Goals
- Support for IE10+??
- Lightweight / easy on dependencies
- tus.io enabled
- ES6
- Robust (retries / resumes for *all the things*), avoid showing 'weird errors'
- Small core, pluggable architecture for adding more file sources: (webcam / google drive / dropbox / etc)
- Themable UI with a beautiful default. UI is opt-out if people want to use just tus for instance
Check [open issues](https://github.com/transloadit/transloadit-js-client/milestones/Minimum%20Viable%20Product) for our Minimum Viable Product.
## Local Development
First clone and install the project:
```bash
git clone git@github.com:transloadit/transloadit-js-client.git
cd transloadit-js-client
npm install
```
Now to get a sandbox environment set up, type:
```bash
npm run preview
```
This will `npm run build` the project into `./build`, and then serve that
directory using a simple static http server.