Skip to content

Commit e80db0b

Browse files
committed
doc(all): update readme
1 parent 4aaf2f2 commit e80db0b

File tree

8 files changed

+272
-16
lines changed

8 files changed

+272
-16
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
Generate sealed class hierarchy for Dart and Flutter.
1010

11+
**NOTE** that this is only a clone of the upstream git repository
12+
which I have fixed some issues and updated some dependencies.
13+
1114
## Features
1215

1316
* Generate sealed class with abstract super type and data subclasses.
@@ -26,12 +29,41 @@ Generate sealed class hierarchy for Dart and Flutter.
2629

2730
Add dependencies in your `pubspec.yaml` file.
2831

32+
Since this is not the original repository, you can not use like this:
33+
34+
```yaml
35+
# WON'T WORK LIKE THIS:
36+
dependencies:
37+
sealed_annotations: '2.0.0'
38+
39+
dev_dependencies:
40+
sealed_generators: '2.0.0'
41+
```
42+
43+
Instead, use like this:
44+
45+
This will override the three dependencies to be downloaded from git.
46+
2947
```yaml
3048
dependencies:
31-
sealed_annotations: ^latest.version
49+
sealed_annotations: '2.0.0'
3250

3351
dev_dependencies:
34-
sealed_generators: ^latest.version
52+
sealed_generators: '2.0.0'
53+
54+
dependency_overrides:
55+
sealed_annotations:
56+
git:
57+
url: https://github.com/FatulM/dart_sealed
58+
path: sealed_annotations/
59+
sealed_writer:
60+
git:
61+
url: https://github.com/FatulM/dart_sealed
62+
path: sealed_writer/
63+
sealed_generators:
64+
git:
65+
url: https://github.com/FatulM/dart_sealed
66+
path: sealed_generators/
3567
```
3668
3769
Import `sealed_annotations`.

example/README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
Generate sealed class hierarchy for Dart and Flutter.
1010

11+
**NOTE** that this is only a clone of the upstream git repository
12+
which I have fixed some issues and updated some dependencies.
13+
1114
## Features
1215

1316
* Generate sealed class with abstract super type and data subclasses.
@@ -26,12 +29,41 @@ Generate sealed class hierarchy for Dart and Flutter.
2629

2730
Add dependencies in your `pubspec.yaml` file.
2831

32+
Since this is not the original repository, you can not use like this:
33+
34+
```yaml
35+
# WON'T WORK LIKE THIS:
36+
dependencies:
37+
sealed_annotations: '2.0.0'
38+
39+
dev_dependencies:
40+
sealed_generators: '2.0.0'
41+
```
42+
43+
Instead, use like this:
44+
45+
This will override the three dependencies to be downloaded from git.
46+
2947
```yaml
3048
dependencies:
31-
sealed_annotations: ^latest.version
49+
sealed_annotations: '2.0.0'
3250

3351
dev_dependencies:
34-
sealed_generators: ^latest.version
52+
sealed_generators: '2.0.0'
53+
54+
dependency_overrides:
55+
sealed_annotations:
56+
git:
57+
url: https://github.com/FatulM/dart_sealed
58+
path: sealed_annotations/
59+
sealed_writer:
60+
git:
61+
url: https://github.com/FatulM/dart_sealed
62+
path: sealed_writer/
63+
sealed_generators:
64+
git:
65+
url: https://github.com/FatulM/dart_sealed
66+
path: sealed_generators/
3567
```
3668
3769
Import `sealed_annotations`.

sealed_annotations/README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
Generate sealed class hierarchy for Dart and Flutter.
1010

11+
**NOTE** that this is only a clone of the upstream git repository
12+
which I have fixed some issues and updated some dependencies.
13+
1114
## Features
1215

1316
* Generate sealed class with abstract super type and data subclasses.
@@ -26,12 +29,41 @@ Generate sealed class hierarchy for Dart and Flutter.
2629

2730
Add dependencies in your `pubspec.yaml` file.
2831

32+
Since this is not the original repository, you can not use like this:
33+
34+
```yaml
35+
# WON'T WORK LIKE THIS:
36+
dependencies:
37+
sealed_annotations: '2.0.0'
38+
39+
dev_dependencies:
40+
sealed_generators: '2.0.0'
41+
```
42+
43+
Instead, use like this:
44+
45+
This will override the three dependencies to be downloaded from git.
46+
2947
```yaml
3048
dependencies:
31-
sealed_annotations: ^latest.version
49+
sealed_annotations: '2.0.0'
3250

3351
dev_dependencies:
34-
sealed_generators: ^latest.version
52+
sealed_generators: '2.0.0'
53+
54+
dependency_overrides:
55+
sealed_annotations:
56+
git:
57+
url: https://github.com/FatulM/dart_sealed
58+
path: sealed_annotations/
59+
sealed_writer:
60+
git:
61+
url: https://github.com/FatulM/dart_sealed
62+
path: sealed_writer/
63+
sealed_generators:
64+
git:
65+
url: https://github.com/FatulM/dart_sealed
66+
path: sealed_generators/
3567
```
3668
3769
Import `sealed_annotations`.

sealed_annotations/example/README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
Generate sealed class hierarchy for Dart and Flutter.
1010

11+
**NOTE** that this is only a clone of the upstream git repository
12+
which I have fixed some issues and updated some dependencies.
13+
1114
## Features
1215

1316
* Generate sealed class with abstract super type and data subclasses.
@@ -26,12 +29,41 @@ Generate sealed class hierarchy for Dart and Flutter.
2629

2730
Add dependencies in your `pubspec.yaml` file.
2831

32+
Since this is not the original repository, you can not use like this:
33+
34+
```yaml
35+
# WON'T WORK LIKE THIS:
36+
dependencies:
37+
sealed_annotations: '2.0.0'
38+
39+
dev_dependencies:
40+
sealed_generators: '2.0.0'
41+
```
42+
43+
Instead, use like this:
44+
45+
This will override the three dependencies to be downloaded from git.
46+
2947
```yaml
3048
dependencies:
31-
sealed_annotations: ^latest.version
49+
sealed_annotations: '2.0.0'
3250

3351
dev_dependencies:
34-
sealed_generators: ^latest.version
52+
sealed_generators: '2.0.0'
53+
54+
dependency_overrides:
55+
sealed_annotations:
56+
git:
57+
url: https://github.com/FatulM/dart_sealed
58+
path: sealed_annotations/
59+
sealed_writer:
60+
git:
61+
url: https://github.com/FatulM/dart_sealed
62+
path: sealed_writer/
63+
sealed_generators:
64+
git:
65+
url: https://github.com/FatulM/dart_sealed
66+
path: sealed_generators/
3567
```
3668
3769
Import `sealed_annotations`.

sealed_generators/README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
Generate sealed class hierarchy for Dart and Flutter.
1010

11+
**NOTE** that this is only a clone of the upstream git repository
12+
which I have fixed some issues and updated some dependencies.
13+
1114
## Features
1215

1316
* Generate sealed class with abstract super type and data subclasses.
@@ -26,12 +29,41 @@ Generate sealed class hierarchy for Dart and Flutter.
2629

2730
Add dependencies in your `pubspec.yaml` file.
2831

32+
Since this is not the original repository, you can not use like this:
33+
34+
```yaml
35+
# WON'T WORK LIKE THIS:
36+
dependencies:
37+
sealed_annotations: '2.0.0'
38+
39+
dev_dependencies:
40+
sealed_generators: '2.0.0'
41+
```
42+
43+
Instead, use like this:
44+
45+
This will override the three dependencies to be downloaded from git.
46+
2947
```yaml
3048
dependencies:
31-
sealed_annotations: ^latest.version
49+
sealed_annotations: '2.0.0'
3250

3351
dev_dependencies:
34-
sealed_generators: ^latest.version
52+
sealed_generators: '2.0.0'
53+
54+
dependency_overrides:
55+
sealed_annotations:
56+
git:
57+
url: https://github.com/FatulM/dart_sealed
58+
path: sealed_annotations/
59+
sealed_writer:
60+
git:
61+
url: https://github.com/FatulM/dart_sealed
62+
path: sealed_writer/
63+
sealed_generators:
64+
git:
65+
url: https://github.com/FatulM/dart_sealed
66+
path: sealed_generators/
3567
```
3668
3769
Import `sealed_annotations`.

sealed_generators/example/README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
Generate sealed class hierarchy for Dart and Flutter.
1010

11+
**NOTE** that this is only a clone of the upstream git repository
12+
which I have fixed some issues and updated some dependencies.
13+
1114
## Features
1215

1316
* Generate sealed class with abstract super type and data subclasses.
@@ -26,12 +29,41 @@ Generate sealed class hierarchy for Dart and Flutter.
2629

2730
Add dependencies in your `pubspec.yaml` file.
2831

32+
Since this is not the original repository, you can not use like this:
33+
34+
```yaml
35+
# WON'T WORK LIKE THIS:
36+
dependencies:
37+
sealed_annotations: '2.0.0'
38+
39+
dev_dependencies:
40+
sealed_generators: '2.0.0'
41+
```
42+
43+
Instead, use like this:
44+
45+
This will override the three dependencies to be downloaded from git.
46+
2947
```yaml
3048
dependencies:
31-
sealed_annotations: ^latest.version
49+
sealed_annotations: '2.0.0'
3250

3351
dev_dependencies:
34-
sealed_generators: ^latest.version
52+
sealed_generators: '2.0.0'
53+
54+
dependency_overrides:
55+
sealed_annotations:
56+
git:
57+
url: https://github.com/FatulM/dart_sealed
58+
path: sealed_annotations/
59+
sealed_writer:
60+
git:
61+
url: https://github.com/FatulM/dart_sealed
62+
path: sealed_writer/
63+
sealed_generators:
64+
git:
65+
url: https://github.com/FatulM/dart_sealed
66+
path: sealed_generators/
3567
```
3668
3769
Import `sealed_annotations`.

sealed_writer/README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
Generate sealed class hierarchy for Dart and Flutter.
1010

11+
**NOTE** that this is only a clone of the upstream git repository
12+
which I have fixed some issues and updated some dependencies.
13+
1114
## Features
1215

1316
* Generate sealed class with abstract super type and data subclasses.
@@ -26,12 +29,41 @@ Generate sealed class hierarchy for Dart and Flutter.
2629

2730
Add dependencies in your `pubspec.yaml` file.
2831

32+
Since this is not the original repository, you can not use like this:
33+
34+
```yaml
35+
# WON'T WORK LIKE THIS:
36+
dependencies:
37+
sealed_annotations: '2.0.0'
38+
39+
dev_dependencies:
40+
sealed_generators: '2.0.0'
41+
```
42+
43+
Instead, use like this:
44+
45+
This will override the three dependencies to be downloaded from git.
46+
2947
```yaml
3048
dependencies:
31-
sealed_annotations: ^latest.version
49+
sealed_annotations: '2.0.0'
3250

3351
dev_dependencies:
34-
sealed_generators: ^latest.version
52+
sealed_generators: '2.0.0'
53+
54+
dependency_overrides:
55+
sealed_annotations:
56+
git:
57+
url: https://github.com/FatulM/dart_sealed
58+
path: sealed_annotations/
59+
sealed_writer:
60+
git:
61+
url: https://github.com/FatulM/dart_sealed
62+
path: sealed_writer/
63+
sealed_generators:
64+
git:
65+
url: https://github.com/FatulM/dart_sealed
66+
path: sealed_generators/
3567
```
3668
3769
Import `sealed_annotations`.

0 commit comments

Comments
 (0)