From 7e518be4178c289c0f1a42b362a9e067453bd011 Mon Sep 17 00:00:00 2001 From: Thijs Koerselman Date: Sat, 20 Jul 2019 14:23:45 +0200 Subject: [PATCH] Initial commit --- LICENSE | 21 +++++++++++++++++++++ README.md | 13 +++++++++++++ package.json | 19 +++++++++++++++++++ 3 files changed, 53 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 package.json diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7dca527 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Thijs Koerselman + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..441f3b3 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Firestore MobX + +## Install + +`yarn add firestore-mobx` or `npm install firestore-mobx` + +## Usage + +## API + +### ObservableDocument + +### ObservableCollection diff --git a/package.json b/package.json new file mode 100644 index 0000000..71929de --- /dev/null +++ b/package.json @@ -0,0 +1,19 @@ +{ + "name": "firestore-mobx", + "version": "0.0.1-0", + "description": "Observable Firestore documents and collections using MobX", + "main": "dist/index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 0" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/0x80/firestore-mobx.git" + }, + "author": "Thijs Koerselman ", + "license": "MIT", + "bugs": { + "url": "https://github.com/0x80/firestore-mobx/issues" + }, + "homepage": "https://github.com/0x80/firestore-mobx#readme" +}