search

aerogear / offix-android

Apollo GraphQL offline extensions for Android Platform
https://android.offix.dev
Apache License 2.0
37 stars 16 forks source link

Document the codebase #48

Closed harshithdwivedi closed 5 years ago

harshithdwivedi commented 5 years ago

Properly document the current codebase, the docs should include :

  1. Brief overview of the libraty
  2. Installation steps
  3. Sample usage (with a screenshot/gif if possible)
  4. Bugs
  5. Features in development

@Lavanyagaur22 this should be your number 1 priority.

Lavanyagaur22 commented 5 years ago

Since our library is not published, the user will have to clone this project and make a sample app in it putting the library dependency in Gradle. So do I need to mention this?

wtrocki commented 5 years ago

Assume library is published

harshithdwivedi commented 5 years ago

Yeah, just assume that library is published and add a placeholder dependency for now.

On Wed, Jul 17, 2019, 3:34 AM Wojtek Trocki notifications@github.com wrote:

Assume library is published

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/aerogear/offix-android/issues/48?email_source=notifications&email_token=ALLWCVBBNUSUC7Z5J6VVCGLP7ZAW5A5CNFSM4IEAVP2KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD2CJMNA#issuecomment-512005684, or mute the thread https://github.com/notifications/unsubscribe-auth/ALLWCVHBUIU4TRZWD3CEQADP7ZAW5ANCNFSM4IEAVP2A .