Skip to content

Commit

Permalink
updated readme and package details
Browse files Browse the repository at this point in the history
  • Loading branch information
tomgobich committed Jun 10, 2024
1 parent 81fe7fe commit e39965f
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 5 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@

> Easily make and generate DTOs from Lucid Models

[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]

Converting Lucid Models to DTO files can be a tedious task.
This package aims to make it a little less so,
by reading your model's property definitions and porting them to a DTO-safe format.
This package aims to make it a little less so
by reading your model's property definitions and porting them to a DTO.
Will it be perfect? Likely not, but it should help cut back on the
repetition needed to complete the task.

Expand Down Expand Up @@ -297,3 +300,14 @@ It's got the
- Getters and their types, when specified. If types are inferred, the type will default to string or boolean if variable name starts with `is`
- Constructor value setters for all of the above
- A helper method `fromArray` that'll normalize to an empty array if need be

[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adocasts/package-dto/test.yml?style=for-the-badge
[gh-workflow-url]: https://github.com/adocasts/package-dto/actions/workflows/test.yml "Github action"

[npm-image]: https://img.shields.io/npm/v/@adocasts.com/dto/latest.svg?style=for-the-badge&logo=npm
[npm-url]: https://www.npmjs.com/package/@adocasts.com/dto/v/latest "npm"

[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript

[license-url]: LICENSE.md
[license-image]: https://img.shields.io/github/license/adocasts/package-dto?style=for-the-badge
14 changes: 11 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@adocasts.com/dto",
"description": "",
"version": "0.0.0",
"description": "Easily make and generate DTOs from Lucid Models",
"version": "0.0.1",
"engines": {
"node": ">=20.6.0"
},
Expand Down Expand Up @@ -36,9 +36,17 @@
"prepublishOnly": "npm run build",
"index:commands": "adonis-kit index build/commands"
},
"keywords": [],
"keywords": ["adonisjs", "lucid", "dto", "generate", "make"],
"author": "tomgobich,adocasts.com",
"license": "MIT",
"homepage": "https://github.com/adocasts/package-dto#readme",
"repository": {
"type": "git",
"url": "git+https://github.com/adocasts/package-dto.git"
},
"bugs": {
"url": "https://github.com/adocasts/package-dto/issues"
},
"devDependencies": {
"@adonisjs/assembler": "^7.2.3",
"@adonisjs/core": "^6.3.1",
Expand Down

0 comments on commit e39965f

Please sign in to comment.