Skip to content

Commit

Permalink
chore: add README.md tu published package
Browse files Browse the repository at this point in the history
Signed-off-by: Octanium <octaniumcontact@gmail.com>
0ctanium committed Mar 18, 2024
1 parent 2a8a9f9 commit 7e42c10
Showing 4 changed files with 10 additions and 19 deletions.
10 changes: 0 additions & 10 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
13 changes: 6 additions & 7 deletions packages/problem-js/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# problem-js
# ProblemJs

This library was generated with [Nx](https://nx.dev).
Problem-js is a JavaScript integration for the Problem Details for HTTP APIs standard (see [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457))

## Building
> [!NOTE]
> This file is still a Work In Progress...
Run `nx build problem-js` to build the library.
## How to contribute

## Running unit tests

Run `nx test problem-js` to execute the unit tests via [Vitest](https://vitest.dev/).
See [CONTRIBUTING.md](./CONTRIBUTING.md)
1 change: 1 addition & 0 deletions packages/problem-js/package.json
Original file line number Diff line number Diff line change
@@ -2,6 +2,7 @@
"name": "problem-js",
"version": "0.0.1",
"description": "Problem-js is a JavaScript integration for the Problem Details for HTTP APIs standard (RFC 9457)",
"license": "MIT",
"keywords": [
"errors",
"middleware",
4 changes: 2 additions & 2 deletions packages/problem-js/project.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "problem-js",
"$schema": "../../node_modules/nx/schemas/project-schema.json",
"sourceRoot": "packages/problem-js/src",
"sourceRoot": "packages/problem-js",
"projectType": "library",
"targets": {
"build": {
@@ -11,7 +11,7 @@
"outputPath": "dist/packages/problem-js",
"main": "packages/problem-js/src/index.ts",
"tsConfig": "packages/problem-js/tsconfig.lib.json",
"assets": [],
"assets": ["packages/problem-js/README.md"],
"project": "packages/problem-js/package.json",
"compiler": "swc",
"format": ["cjs", "esm"]

0 comments on commit 7e42c10

Please sign in to comment.