Browse Source

Update package data, test README publishing

Use lower npm version to publish packages.
tags/0.3.0
TheoryOfNekomata 3 years ago
parent
commit
9971797b27
2 changed files with 6 additions and 39 deletions
  1. +2
    -38
      README.md
  2. +4
    -1
      package.json

+ 2
- 38
README.md View File

@@ -1,39 +1,7 @@
# Tesseract Design - React Common # 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. 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 ## Usage


The package includes components as named exports. Simply import the components you need individually or use a namespace 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 => (
</legend> </legend>
<div> <div>
<T.TextInput <T.TextInput
name="username"
label="Username" label="Username"
/> />
</div> </div>
<div> <div>
<T.TextInput <T.TextInput
name="password"
type="password" type="password"
label="Password" label="Password"
/> />
@@ -82,13 +52,7 @@ ReactDOM.render(
window.document.body.appendChild(mountNode) window.document.body.appendChild(mountNode)
``` ```


Detailed usage guides can be found in the documentation linked above.

## TypeScript ## TypeScript


The package is written and tested using TypeScript. Thus, typings for consumption in TypeScript are bundled with the The package is written and tested using TypeScript. Thus, typings for consumption in TypeScript are bundled with the
compiled source. compiled source.

## License

MIT. See the LICENSE file on the package repository for the full text.

+ 4
- 1
package.json View File

@@ -2,7 +2,7 @@
"name": "@tesseract-design/react-common", "name": "@tesseract-design/react-common",
"title": "React Common", "title": "React Common",
"org": "Tesseract Design", "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.", "description": "Common front-end components for Web using the Tesseract design system, written in React.",
"directories": { "directories": {
"lib": "dist" "lib": "dist"
@@ -13,6 +13,9 @@
"author": "TheoryOfNekomata <allan.crisostomo@outlook.com>", "author": "TheoryOfNekomata <allan.crisostomo@outlook.com>",
"license": "MIT", "license": "MIT",
"private": false, "private": false,
"bugs": {
"url": "https://code.modal.sh/tesseract-design/react-common/issues"
},
"devDependencies": { "devDependencies": {
"@babel/runtime": "^7.12.5", "@babel/runtime": "^7.12.5",
"@rollup/plugin-typescript": "^5.0.2", "@rollup/plugin-typescript": "^5.0.2",


Loading…
Cancel
Save