Skip to content

Commit

Permalink
update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
KarnerTh committed Nov 10, 2024
1 parent ea2a9c4 commit eeb9912
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 2 deletions.
11 changes: 9 additions & 2 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,20 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) (after version 0.0.5).

## [0.12.0] - 2024-0
### Added
- new `--outputMode` option ([PR #63](https://github.com/KarnerTh/mermerd/pull/63))

### Changed
- go 1.23 is now used

## [0.11.0] - 2024-06-16
### Added
- new `--ignoreTables` option ([PR #59](https://github.com/KarnerTh/mermerd/pull/59))

### Changed
- go 1.22 is now used

### Fixed

## [0.10.0] - 2023-11-21
### Added
- Support relationship labels ([PR #50](https://github.com/KarnerTh/mermerd/pull/50))
Expand Down Expand Up @@ -155,6 +160,8 @@ by `--showDescriptions enumValues` (for details see [PR #32](https://github.com/
### Added
- Initial release of mermerd

[0.12.0]: https://github.com/KarnerTh/mermerd/releases/tag/v0.12.0

[0.11.0]: https://github.com/KarnerTh/mermerd/releases/tag/v0.11.0

[0.10.0]: https://github.com/KarnerTh/mermerd/releases/tag/v0.10.0
Expand Down
1 change: 1 addition & 0 deletions exampleRunConfig.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ encloseWithMermaidBackticks: false
debug: false
omitConstraintLabels: false
omitAttributeKeys: false
outputMode: stdout
showDescriptions:
- enumValues
- columnComments
Expand Down
5 changes: 5 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ via `mermerd -h`
--omitAttributeKeys omit the attribute keys (PK, FK, UK)
--omitConstraintLabels omit the constraint labels
-o, --outputFileName string output file name (default "result.mmd")
--outputMode OutputModeType output mode (file, stdout) (default file)
--runConfig string run configuration (replaces global configuration)
-s, --schema string schema that should be used
--schemaPrefixSeparator string the separator that should be used between schema and table name (default ".")
Expand Down Expand Up @@ -146,6 +147,7 @@ selectedTables:
showAllConstraints: true
encloseWithMermaidBackticks: true
outputFileName: "my-db.mmd"
outputMode: stdout
debug: true
omitConstraintLabels: true
omitAttributeKeys: true
Expand Down Expand Up @@ -181,6 +183,9 @@ mermerd -c "postgresql://user:password@localhost:5432/yourDb" -s public
# same as previous one, but use all available tables without interaction
mermerd -c "postgresql://user:password@localhost:5432/yourDb" -s public --useAllTables
# same as previous one, but get the result in stdout instead of a file
mermerd -c "postgresql://user:password@localhost:5432/yourDb" -s public --useAllTables --outputMode stdout
# same as previous one, but use a list of tables without interaction
mermerd -c "postgresql://user:password@localhost:5432/yourDb" -s public --selectedTables article,article_label
Expand Down

0 comments on commit eeb9912

Please sign in to comment.