Skip to content

Commit

Permalink
docs: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
robmllze committed Nov 11, 2024
1 parent 1f73435 commit 66dbb8d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## [0.9.1]

- Released @ 10/2024 (UTC)
- docs: Update readme

## [0.9.0]

- Released @ 10/2024 (UTC)
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ A tool for generating data models and classes from annotations, offering greater

Below are some basic steps to get you started with this package. This package is designed to work with the [`df_generate_dart_models_core`](https://pub.dev/packages/df_generate_dart_models_core) package, which provides the core functionality for generating models.

The example below provides a glimpse of what this package can do. It also includes advanced features such as AI-driven generation, customizable type mappers, template files, model conversion to other programming languages, and more. Please note that these advanced features are still in development and not yet documented. Feel free to contact the developer for more information.
The example below provides a glimpse of what this package can do. The package includes advanced features such as AI-driven generation, customizable type mappers, template files, model conversion to other programming languages, and mor but these advanced features are still in development and not yet documented. Feel free to contact the developer if you require more information.

## Getting Started

### Step 1:

Install this tool by running `dart pub global activate df_generate_dart_models` in your terminal.
To install this tool, `run dart pub global activate df_generate_dart_models 0.9.1` in your terminal. You can replace `0.9.1` with any other version or omit it to install the latest version. It’s recommended to specify a version to avoid potential issues from frequent updates and changes.

### Step 2:

Add [`df_generate_dart_models_core`](https://pub.dev/packages/df_generate_dart_models_core) to your `pubspec.yaml` file.

```yaml
dependencies:
df_generate_dart_models_core: any # use the latest version
df_generate_dart_models_core: 0.6.8 # Fixed version to ensure compatibility and avoid issues from frequent updates.
```
### Step 3:
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

name: df_generate_dart_models
description: A tool for generating data models and classes from annotations, offering greater flexibility than json_serializable or freezed.
version: 0.9.0
version: 0.9.1
repository: https://github.com/robmllze/df_generate_dart_models
funding:
- https://www.buymeacoffee.com/robmllze
Expand Down

0 comments on commit 66dbb8d

Please sign in to comment.