Browse Source

add readme and license

Artur Paikin 6 years ago
parent
commit
af373b3a21
2 changed files with 60 additions and 0 deletions
  1. 21 0
      packages/@uppy/locales/LICENSE
  2. 39 0
      packages/@uppy/locales/README.md

+ 21 - 0
packages/@uppy/locales/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 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.

+ 39 - 0
packages/@uppy/locales/README.md

@@ -0,0 +1,39 @@
+# @uppy/locales
+
+<img src="https://uppy.io/images/logos/uppy-dog-head-arrow.svg" width="120" alt="Uppy logo: a superman puppy in a pink suit" align="right">
+
+<a href="https://www.npmjs.com/package/@uppy/locales"><img src="https://img.shields.io/npm/v/@uppy/locales.svg?style=flat-square"></a>
+<a href="https://travis-ci.org/transloadit/uppy"><img src="https://img.shields.io/travis/transloadit/uppy/master.svg?style=flat-square" alt="Build Status"></a>
+
+This packages contains all of the locale packs that you can use to make Uppy speak your language! If your language is missing, please consider [contributing](https://github.com/transloadit/uppy/tree/master/packages/%40uppy/locales/src), starting with `en_US`, which is always up-to-date automatically.
+
+## Installation
+
+```bash
+$ npm install @uppy/locales --save
+```
+
+## Documentation
+
+```bash
+$ npm install @uppy/core @uppy/locales --save
+```
+
+```js
+const Uppy = require('uppy/core')
+const Russian = require('uppy/locales/lib/ru_RU)
+const uppy = Uppy({
+  debug: true,
+  meta: {
+    username: 'John',
+    license: 'Creative Commons'
+  },
+  locale: Russian
+})
+```
+
+Please see [locale docs](https://uppy.io/docs/uppy/#locale) for more details.
+
+## License
+
+[The MIT License](./LICENSE).