Skip to content

Commit c87d981

Browse files
JoseAlcerrecaJoseAlcerreca
committed
Update README.md
1 parent 391b0bb commit c87d981

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

‎README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
1-
# Android Architecture Blueprints [beta] - draft
1+
# Android Architecture Blueprints [beta]
22

3-
The Android framework is very flexible when it comes to defining how to
4-
organize and <em>architect</em> an Android app. This freedom comes at a price: Huge classes, inconsistent
5-
naming patterns and architectures (or lack of) that make testing, maintaining
6-
and extending difficult.
3+
The Android framework offers a lot of flexibility when it comes to defining how
4+
to organize and <em>architect</em> an Android app. This freedom, whilst very valuable, can also result in apps
5+
with large classes, inconsistent naming and architectures (or lack of) that can
6+
make testing, maintaining and extending difficult.
77

8-
Android Architecture Blueprints is meant to help developers compare quickly. In
9-
this project we offer the same to-do application implemented using different
10-
architectural concepts and tools. Examples are MVP, MVVM, Dagger2, Data Binding
11-
Library, RxJava, Loaders…
8+
Android Architecture Blueprints is meant to demonstrate possible ways to help
9+
with these common problems. In this project we offer the same application
10+
implemented using different architectural concepts and tools.
11+
12+
You can use these samples as a reference or as a starting point for creating
13+
your own apps. The focus here is on code structure, architecture, testing and
14+
maintainability. However, bear in mind that there are many ways to build apps
15+
with these architectures and tools, depending on your priorities, so these
16+
shouldn't be considered canonical examples. The UI is deliberately kept simple.
1217

1318
### What does <em>beta</em> mean?
1419

@@ -17,26 +22,28 @@ initial number of variants low before the stable release.
1722

1823
## Samples
1924

20-
Check each project's README for more information.
25+
All projects are released in the master branch. Check each project's README for
26+
more information.
2127

22-
* [todo-mvp/](https://github.com/googlesamples/android-architecture/tree/master/todo-mvp) - Basic Model-View-Presenter architecture
23-
* [todo-mvp-loaders/](https://github.com/googlesamples/android-architecture/tree/master/todo-mvp-loaders) - Based in todo-mvp, fetches data using Loaders.
28+
* [todo-mvp/](https://github.com/googlesamples/android-architecture/tree/master/todo-mvp) - Basic Model-View-Presenter architecture.
29+
* [todo-mvp-loaders/](https://github.com/googlesamples/android-architecture/tree/master/todo-mvp-loaders) - Based on todo-mvp, fetches data using Loaders.
30+
* [todo-mvp-databinding/](https://github.com/googlesamples/android-architecture/tree/master/todo-databinding) - Bases on todo-mvp, uses the Data Binding Library.
2431

2532
In progress:
2633

27-
* todo-mvp-dagger/ - Based in todo-mvp, uses the Dagger2 dependency Injection
28-
framework.
29-
* todo-mvp-rxjava/ - Based in todo-mvp, uses RxJava to handle load and observe
30-
data
31-
* todo-databinding/ - Uses the Data Binding Library to display data
32-
* todo-mvp-contentproviders/ - Based in todo-mvp, uses Loaders and Content Providers
33-
* todo-mvp-clean/ - Based in todo-mvp, uses Clean Architecture.
34+
* <strong>todo-mvp-contentproviders</strong> - Based on todo-mvp-loaders, uses Content Providers
35+
* <strong>todo-mvp-clean</strong> - Based on todo-mvp, uses concepts from Clean Architecture.
36+
* <strong>todo-mvp-dagger</strong> - Based on todo-mvp, uses Dagger2 for Dependency Injection
37+
38+
Also, see ["New sample" issues](https://github.com/googlesamples/android-architecture/issues?q=is%3Aissue+is%3Aopen+label%3A%22New+sample%22) for planned samples.
3439

3540
## Why a to-do application?
3641

37-
Check out the <u>app's specification</u>. The aim of the app is to be simple enough that it's understood quickly, but
38-
complex enough to showcase difficult design decisions and hard (but common)
39-
testing scenarios.
42+
The aim of the app is to be simple enough that it's understood quickly, but
43+
complex enough to showcase difficult design decisions and testing scenarios.
44+
Check out the [app's specification](https://github.com/googlesamples/android-architecture/wiki/To-do-app-specification).
45+
46+
<img src="https://github.com/googlesamples/android-architecture/wiki/images/tasks2.png" alt="Screenshot" width="160" style="display: inline; float: right"/>
4047

4148
Also, a similar project exists to compare JavaScript frameworks, called [TodoMVC](https://github.com/tastejs/todomvc).
4249

@@ -50,15 +57,8 @@ compact you like your codebase, etc.
5057

5158
## Who is behind this project?
5259

53-
This project is made by the community and curated by Google and core
54-
maintainers. Each sample has a group of owners that look after it keeping it up
55-
to date and handling issues and pull requests.
56-
57-
### Contributors
58-
59-
Apart from the awesome [contributors](https://github.com/googlesamples/android-architecture/contributors), the core team is composed of:
60-
61-
* TODO
60+
This project is made by the [community](https://github.com/googlesamples/android-architecture/graphs/contributors) and curated by Google and core maintainers. Each sample has a group of owners
61+
that look after it keeping it up to date and handling issues and pull requests.
6262

6363
Want to be part of it? [Read on](https://github.com/googlesamples/android-architecture/wiki/Contributions).
6464

0 commit comments

Comments
 (0)