From 9971797b2794fda7a7573cccfb1b323a2a0b5bc9 Mon Sep 17 00:00:00 2001 From: TheoryOfNekomata Date: Sun, 28 Mar 2021 09:36:58 +0800 Subject: [PATCH] Update package data, test README publishing Use lower npm version to publish packages. --- README.md | 40 ++-------------------------------------- package.json | 5 ++++- 2 files changed, 6 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index f5fcd78..1065d55 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,7 @@ # Tesseract Design - React Common -Common front-end components for Web using the [Tesseract design system](https://make.modal.sh/tesseract/design), written for [React](https://reactjs.org). - -Package: - -[![@tesseract-design/react-common](https://code.modal.sh/badge?repo=tesseract-design/react-common&type=package&color=C78AB3&kind=name)](https://js.pack.modal.sh/-/web/detail/@tesseract-design/react-common) -[![Version List](https://code.modal.sh/badge?repo=tesseract-design/react-common&type=package&color=C78AB3&kind=version)](https://js.pack.modal.sh/-/web/detail/@tesseract-design/react-common#versions) - -Dependencies: - -[![React](https://code.modal.sh/badge?repo=tesseract-design/react-common&type=dependency&dependency=react&kind=peerDependencies)](https://github.com/facebook/react) -[![Styled Components](https://code.modal.sh/badge?repo=tesseract-design/react-common&type=dependency&dependency=styled-components&kind=peerDependencies)](https://github.com/styled-components/styled-components) -[![TypeScript](https://code.modal.sh/badge?repo=tesseract-design/react-common&type=dependency&dependency=typescript&kind=devDependencies)](https://github.com/microsoft/typescript) -[![Jest](https://code.modal.sh/badge?repo=tesseract-design/react-common&type=dependency&dependency=jest&kind=devDependencies)](https://github.com/facebook/jest) -[![Rollup](https://code.modal.sh/badge?repo=tesseract-design/react-common&type=dependency&dependency=rollup&kind=devDependencies)](https://github.com/rollup/rollup) - Check the [documentation](https://make.modal.sh/tesseract/web/react/common) for more details. -## Installation - -This package resides primarily in the [Modal.sh JavaScript Package Registry](https://js.pack.modal.sh/). You will need to -adjust configuration in your chosen package manager. - -With [Yarn v.1.x](https://classic.arnpkg.com), add this to your `.yarnrc` file: - -```yarnrc -"@tesseract-design:registry" "https://js.pack.modal.sh/" -``` - -Then, install the package by running the following command: - -```shell script -yarn add @tesseract-design/react-common -``` - ## Usage The package includes components as named exports. Simply import the components you need individually or use a namespace @@ -54,11 +22,13 @@ const LoginForm = etcProps => (
@@ -82,13 +52,7 @@ ReactDOM.render( window.document.body.appendChild(mountNode) ``` -Detailed usage guides can be found in the documentation linked above. - ## TypeScript The package is written and tested using TypeScript. Thus, typings for consumption in TypeScript are bundled with the compiled source. - -## License - -MIT. See the LICENSE file on the package repository for the full text. diff --git a/package.json b/package.json index 98817fe..3716c0e 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@tesseract-design/react-common", "title": "React Common", "org": "Tesseract Design", - "version": "0.2.7", + "version": "0.3.0", "description": "Common front-end components for Web using the Tesseract design system, written in React.", "directories": { "lib": "dist" @@ -13,6 +13,9 @@ "author": "TheoryOfNekomata ", "license": "MIT", "private": false, + "bugs": { + "url": "https://code.modal.sh/tesseract-design/react-common/issues" + }, "devDependencies": { "@babel/runtime": "^7.12.5", "@rollup/plugin-typescript": "^5.0.2",