From 7e42c1051ad0c8ba9cfc5c4d8de7cf39a4989d50 Mon Sep 17 00:00:00 2001 From: Octanium Date: Mon, 18 Mar 2024 11:19:56 +0100 Subject: [PATCH] chore: add README.md tu published package Signed-off-by: Octanium --- README.md | 11 +---------- packages/problem-js/README.md | 13 ++++++------- packages/problem-js/package.json | 1 + packages/problem-js/project.json | 4 ++-- 4 files changed, 10 insertions(+), 19 deletions(-) mode change 100644 => 120000 README.md diff --git a/README.md b/README.md deleted file mode 100644 index c310168..0000000 --- a/README.md +++ /dev/null @@ -1,10 +0,0 @@ -# ProblemJs - -Problem-js is a JavaScript integration for the Problem Details for HTTP APIs standard (see [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457)) - -> [!NOTE] -> This file is still a Work In Progress... - -## How to contribute - -See [CONTRIBUTING.md](./CONTRIBUTING.md) diff --git a/README.md b/README.md new file mode 120000 index 0000000..f7e5f36 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +packages/problem-js/README.md \ No newline at end of file diff --git a/packages/problem-js/README.md b/packages/problem-js/README.md index cf1a7f2..c310168 100644 --- a/packages/problem-js/README.md +++ b/packages/problem-js/README.md @@ -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) diff --git a/packages/problem-js/package.json b/packages/problem-js/package.json index ff94d76..7fff904 100644 --- a/packages/problem-js/package.json +++ b/packages/problem-js/package.json @@ -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", diff --git a/packages/problem-js/project.json b/packages/problem-js/project.json index 4372b3f..dfecab8 100644 --- a/packages/problem-js/project.json +++ b/packages/problem-js/project.json @@ -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"]