Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Improvements #74

Open
julianfalcionelli opened this issue Apr 13, 2021 · 1 comment
Open

Documentation Improvements #74

julianfalcionelli opened this issue Apr 13, 2021 · 1 comment

Comments

@julianfalcionelli
Copy link
Contributor

We are adding many functionalities to the project, so it would be good to go by adding references to each of these functionalities in the Readme or in the Wiki, making references to the code/classes and useful documentation. It could be something like:

List of functionalities in this project:

  • Push Notifications: Firebase Push Notifications was integrated.
  • REST API: For this we use Retrofit. The core class is RetrofitManager, which contains several ways to configure our Http instances, such as cache configuration, logs, and more.
  • MotionLayout
  • Camera
  • etc...

We can also talk a bit about the architecture and some design patterns that we use such as Dependency Injection, Dependency Inversion, etc.

We can do this together, each one can focus on the functionalities in which they mainly work.

@IvanToplak
Copy link
Contributor

I've updated documentation in readme file.
It's not a final list of functionalities that we implemented, but I did cover most of it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants