diff --git a/README.md b/README.md index a311eb7..cb6486d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,30 @@ ## Clean Architecture Generator -A CLI and Android Studio plugin for generating Clean Architecture boilerplate including features, data sources, use cases, ViewModels, and architecture packages. +A CLI and Android Studio plugin for generating Clean Architecture boilerplate including whole projects, features, data sources, use cases, ViewModels, and architecture packages. ### Android Studio plugin Adds multiple time-saving code generation shortcuts to Android Studio. -Key features: +For a working project example, visit [Clean Architecture For Android](https://github.com/EranBoudjnah/CleanArchitectureForAndroid). -- New Clean Architecture project template +Key features: -- New menu items: +- **Android Studio Plugin** + - Available on the IDE Plugins Marketplace + - New Clean Architecture project template + - New menu items: + - New architecture package + - New feature + - New use case in domain modules + - New ViewModel in presentation modules + - New data source + + +- **Terminal command** + - Available via Homebrew + - Generate: + - New Clean Architecture project - New architecture package - New feature - New use case in domain modules