From becf07786c05794ad0b2d00c9aaf9604079b6905 Mon Sep 17 00:00:00 2001 From: "Valentin D. Pinkman" Date: Fri, 12 Apr 2024 15:31:45 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20(readme):=20Use=20a=20table=20fo?= =?UTF-8?q?r=20project=20display?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9b670fe87..1afe2fbc2 100644 --- a/README.md +++ b/README.md @@ -65,14 +65,16 @@ This project uses [turbo monorepo](https://turbo.build/repo/docs) to build and r A brief description of this project packages: -* `@ledgerhq/device-sdk-sample` in `apps/sample`: React Next web app used to test & demonstrate the Web Device SDK -* `@ledgerhq/eslint-config-dsdk` in `packages/config/eslint`: internal package which contains eslint shared config. Used by `extends: ["@ledgerhq/dsdk"]` in `.eslintrc`. -* `@ledgerhq/jest-config-dsdk` in `packages/config/jest`: internal package which contains jest shared config. Used by `preset: "@ledgerhq/jest-config-dsdk"` in `jest.config.ts` -* `@ledgerhq/tsconfig-dsdk` in `packages/config/typescript`: internal package which contains typescript shared config. Used by `"extends": "@ledgerhq/tsconfig-dsdk/sdk"` in `tsconfig.json` -* `@ledgerhq/device-sdk-core` in `packages/core`: external package that contains the core of the Web SDK -* `@ledgerhq/device-sdk-signer` in `packages/signer`: external package -* `@ledgerhq/device-sdk-trusted-apps` in `packages/trusted-apps`: external package -* `@ledgerhq/device-sdk-ui` in `packages/ui`: external package +| Name | Path | Description | +| -- | -- | -- | +| @ledgerhq/device-sdk-sample | apps/sample | React Next web app used to test & demonstrate the Web Device SDK | +| @ledgerhq/eslint-config-dsdk | packages/config/eslint | internal package which contains eslint shared config. Used by `extends: ["@ledgerhq/dsdk"]` in `.eslintrc`. | +| @ledgerhq/jest-config-dsdk | packages/config/jest | internal package which contains jest shared config. Used by `preset: "@ledgerhq/jest-config-dsdk"` in `jest.config.ts` | +| @ledgerhq/tsconfig-dsdk | packages/config/typescript | internal package which contains typescript shared config. Used by `"extends": "@ledgerhq/tsconfig-dsdk/sdk"` in `tsconfig.json` | +| @ledgerhq/device-sdk-core | packages/core | external package that contains the core of the Web SDK | +| @ledgerhq/device-sdk-signer | packages/signer | external package | +| @ledgerhq/device-sdk-trusted-apps | packages/trusted-apps | external package | +| @ledgerhq/device-sdk-ui | packages/ui | external package | # CI