chore: rename package, add documentation

anwar907 · Oct 26, 2023 · 7930a13 · 7930a13
1 parent 73aa854
commit 7930a13
Show file tree

Hide file tree

Showing 13 changed files with 15 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
-## 0.1.2 (2023-10-07)
+## 0.1.3 (2023-10-07)
 
 ### Added
 
 - Improve documentation and performance
-- Add unit test generate file
+- Rename package
diff --git a/README.md b/README.md
@@ -1,19 +1,23 @@
-Don't waste your time when creating your first project to set up your own architecture. This package will help you to improve your setup architecture
+Don't waste your time when creating your first project to set up your own architecture. This package will help you to improve your setup architecture and if you have own architecture related please submit PR to this repo on github
 
 ## Example
 ```md
 app/
 ┣ data/
 ┣ repository/
 ┣ modules/
+┣ index.dart
 core/
+┣ index.dart
 themes/
+┣ index.dart
 utils/
+┣ index.dart
 ```
 
 ## Command usage
 
-- hit `dart pub global activate init_folder_architecture` in your commandline
+- hit `dart pub global activate init_architecture` in your commandline
 - setup path environment in your local machine
 - Inside folder `lib/` hit command ```init --init=app```
 

diff --git a/bin/init_folder_architecture.dart → bin/init_architecture.dart b/bin/init_folder_architecture.dart → bin/init_architecture.dart
@@ -1,7 +1,7 @@
 #!/usr/bin/env dart
 
 import 'package:args/args.dart';
-import 'package:init_folder_architecture/init_folder_architecture.dart';
+import 'package:init_architecture/init_architecture.dart';
 
 void main(List<String> arguments) {
   final parser = ArgParser()..addOption('init', abbr: 'i', mandatory: true);

diff --git a/example/app/data/model.dart b/example/app/data/model.dart
diff --git a/example/app/modules/features.dart b/example/app/modules/features.dart
diff --git a/example/app/repository/repository.dart b/example/app/repository/repository.dart
diff --git a/example/core/core.dart b/example/core/core.dart
diff --git a/example/themes/themes.dart b/example/themes/themes.dart
diff --git a/example/utils/utils.dart b/example/utils/utils.dart
diff --git a/lib/directory.dart b/lib/directory.dart
@@ -1,6 +1,6 @@
 import 'dart:io';
 
-import 'package:init_folder_architecture/files.dart';
+import 'package:init_architecture/files.dart';
 
 // This function generates a folder with the given name if it doesn't already exist.
 // It also creates three sub-folders inside the main folder: 'themes', 'core', and 'utils'.

diff --git a/lib/init_folder_architecture.dart → lib/init_architecture.dart b/lib/init_folder_architecture.dart → lib/init_architecture.dart
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,8 +1,8 @@
-name: init_folder_architecture
+name: init_architecture
 description: >-
   CLI utility will generate folder architecture to help you and save your time when creating the first Flutter project.
-version: 0.1.2
-homepage: https://github.com/anwar907/init_folder_architecture
+version: 0.1.3
+homepage: https://github.com/anwar907/init_architecture
 
 
 environment:
@@ -17,4 +17,4 @@ dev_dependencies:
   test: ^1.21.0
 
 executables:
-  init: init_folder_architecture
+  init: init_architecture
diff --git a/test/init_folder_architecture_test.dart → test/init_architecture_test.dart b/test/init_folder_architecture_test.dart → test/init_architecture_test.dart
@@ -1,6 +1,6 @@
 import 'dart:io';
 
-import 'package:init_folder_architecture/files.dart';
+import 'package:init_architecture/files.dart';
 import 'package:test/test.dart';
 
 void main() {