UNPKG

abstracted-firebase/README.md

Version:

2.09 kBMarkdownView Raw

1[![Build Status](https://travis-ci.org/forest-fire/abstracted-firebase.svg?branch=master)](https://travis-ci.org/forest-fre/abstracted-admin.svg?branch=master)
2[![Coverage Status](https://coveralls.io/repos/github/forest-fire/abstracted-firebase/badge.svg?branch=master)](https://coveralls.io/github/forest-fre/abstracted-admin?branch=master)
3[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
4
5> The underlying library powering `abstracted-admin` and `abstracted-client`
6
7## Basic Usage
8
9It would be unusual to use this library directly, instead it is expected that you would choose one of the following:
10
11* [`abstracted-admin`](https://abstracted-admin.com) - if you're building a backend service and want to leverage the Firebase Admin API
12* `abstracted-client` - if instead you're more interested in working in the client browser then this is the right choice
13
14Both the aforementioned libraries use this library for a majority of their common functionality.
15
16## License
17
18Copyright (c) 2018 LifeGadget Ltd
19
20Permission is hereby granted, free of charge, to any person obtaining a copy of
21this software and associated documentation files (the "Software"), to deal in
22the Software without restriction, including without limitation the rights to
23use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
24of the Software, and to permit persons to whom the Software is furnished to do
25so, subject to the following conditions:
26
27The above copyright notice and this permission notice shall be included in all
28copies or substantial portions of the Software.
29
30THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
31IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
32FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
33AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
34LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
35OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36SOFTWARE.

1	`[![Build Status](https://travis-ci.org/forest-fire/abstracted-firebase.svg?branch=master)](https://travis-ci.org/forest-fre/abstracted-admin.svg?branch=master)`
2	`[![Coverage Status](https://coveralls.io/repos/github/forest-fire/abstracted-firebase/badge.svg?branch=master)](https://coveralls.io/github/forest-fre/abstracted-admin?branch=master)`
3	`[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)`
4
5	> The underlying library powering `abstracted-admin` and `abstracted-client`
6
7	`## Basic Usage`
8
9	`It would be unusual to use this library directly, instead it is expected that you would choose one of the following:`
10
11	* [`abstracted-admin`](https://abstracted-admin.com) - if you're building a backend service and want to leverage the Firebase Admin API
12	* `abstracted-client` - if instead you're more interested in working in the client browser then this is the right choice
13
14	`Both the aforementioned libraries use this library for a majority of their common functionality.`
15
16	`## License`
17
18	`Copyright (c) 2018 LifeGadget Ltd`
19
20	`Permission is hereby granted, free of charge, to any person obtaining a copy of`
21	`this software and associated documentation files (the "Software"), to deal in`
22	`the Software without restriction, including without limitation the rights to`
23	`use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies`
24	`of the Software, and to permit persons to whom the Software is furnished to do`
25	`so, subject to the following conditions:`
26
27	`The above copyright notice and this permission notice shall be included in all`
28	`copies or substantial portions of the Software.`
29
30	`THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR`
31	`IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,`
32	`FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE`
33	`AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER`
34	`LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,`
35	`OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE`
36	`SOFTWARE.`