Skip to content

Commit

Permalink
README.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
mk-5 committed Jun 29, 2019
1 parent 7b96587 commit 02d5093
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@ A libGDX cross-platform API for Firebase.

The first thing you should do is installing Firebase SDK and add gradle dependencies.

- [Android guide](https://github.com/mk-5/gdx-fireapp/wiki/Android-guide)
- [iOS guide](https://github.com/mk-5/gdx-fireapp/wiki/iOS-Guide)
- [GWT guide](https://github.com/mk-5/gdx-fireapp/wiki/GWT-guide)
- [ProGuard rules](https://github.com/mk-5/gdx-fireapp/wiki/Proguard-required-rules)
[Android guide](https://github.com/mk-5/gdx-fireapp/wiki/Android-guide) - [iOS guide](https://github.com/mk-5/gdx-fireapp/wiki/iOS-Guide) - [HTML guide](https://github.com/mk-5/gdx-fireapp/wiki/GWT-guide) - [ProGuard required rules](https://github.com/mk-5/gdx-fireapp/wiki/Proguard-required-rules)

**Core**

Expand All @@ -36,34 +33,34 @@ compile "pl.mk5.gdx-fireapp:gdx-fireapp-ios-moe:$gdxFireappVersion"
compile "pl.mk5.gdx-fireapp:gdx-fireapp-html:$gdxFireappVersion"
```

 
 

**The latest version** was built using libGDX 1.9.8, multi-os-engine 1.4.3, gwt 2.8.0, iOS firebase sdk 5.x,
**The latest version** was built using libGDX 1.9.8, multi-os-engine 1.4.3, gwt 2.8.0, iOS firebase sdk 5.x,
android firebase sdk 16.x

 
 

## Basics

API is something like bridge between libGDX app and firebase sdk. It's cover firebase functionality so if you have some knowledge about firebase SDK - using this API should be intuitive for you.
API is something like bridge between libGDX app and firebase sdk. It's cover firebase functionality so if you have some knowledge about firebase SDK - using this API should be intuitive for you.

 
 

To initialize Firebase SDK just put this line somewhere in your app initialization code:

```java
GdxFIRApp.inst().configure();
```

**Firebase Analytics** should start working just after this step.
**Firebase Analytics** should start working just after this step.

If you added ***Fabric/Crashlytics*** to your project you should initialize it also:

````
GdxFIRCrash.inst().initialize();
````

 
 

Firebase SDK communication is done with following classes:

Expand All @@ -74,25 +71,26 @@ Firebase SDK communication is done with following classes:
- **[GdxFIRDatabase](http://javadoc.io/page/pl.mk5.gdx-fireapp/gdx-fireapp-core/latest/mk/gdx/firebase/GdxFIRDatabase.html)**
- **[GdxFIRCrash](http://javadoc.io/page/pl.mk5.gdx-fireapp/gdx-fireapp-core/latest/mk/gdx/firebase/GdxFIRCrash.html)**

 
 


## Examples

To see some examples please go to [examples wiki page](https://github.com/mk-5/gdx-fireapp/wiki/Examples).

 
 

## Useful links

- [Javadoc](http://javadoc.io/doc/pl.mk5.gdx-fireapp/gdx-fireapp-core)
- [Wiki](https://github.com/mk-5/gdx-fireapp/wiki)

 
 

## What's next?

- Better wiki/documentation
- Cloud Firestore
- Facebook, github authorization
- Messaging
- Upload task monitoring
Expand Down

0 comments on commit 02d5093

Please sign in to comment.