Skip to content

Commit

Permalink
chore: add documenation
Browse files Browse the repository at this point in the history
  • Loading branch information
danielsimao committed Sep 15, 2023
1 parent 7bf3e73 commit 879ef90
Show file tree
Hide file tree
Showing 20 changed files with 462 additions and 70 deletions.
18 changes: 7 additions & 11 deletions .commitlintrc.cjs
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
const conventional = require("@commitlint/config-conventional");
const conventional = require('@commitlint/config-conventional');

module.exports = {
extends: ["@commitlint/config-conventional"],
plugins: ["commitlint-plugin-function-rules"],
helpUrl: "https://github.com/nextui-org/nextui/blob/main/CONTRIBUTING.MD#commit-convention",
extends: ['@commitlint/config-conventional'],
plugins: ['commitlint-plugin-function-rules'],
helpUrl: 'https://github.com/interlay/ui/blob/main/CONTRIBUTING.MD#commit-convention',
rules: {
...conventional.rules,
"type-enum": [
2,
"always",
["feat", "feature", "fix", "refactor", "docs", "build", "test", "ci", "chore"],
],
"function-rules/header-max-length": [0],
},
'type-enum': [2, 'always', ['feat', 'feature', 'fix', 'refactor', 'docs', 'build', 'test', 'ci', 'chore']],
'function-rules/header-max-length': [0]
}
};
4 changes: 2 additions & 2 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Next UI Contributing Guide
# Interlay UI Contributing Guide

Hello!, I am very excited that you are interested in contributing with Next UI. However, before submitting your contribution, be sure to take a moment and read the following guidelines.
Hello!, I am very excited that you are interested in contributing with Interlay UI. However, before submitting your contribution, be sure to take a moment and read the following guidelines.

- [Extraction request guidelines](#pull-request-guidelines)
- [Development Setup](#development-setup)
Expand Down
66 changes: 61 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,71 @@
<p align="center">
<h1 align="center">InterlayUI</h1>
<h1 align="center">Interlay UI</h1>
</p>
</br>

## Getting Started
Interlay IU is library of accessible, reusable, and composable React components built
around a crypto business model

[TODO]
## Table of contents

### Community
- 🚀 [Features](#features)
- 📦 [Installation](#installation)
- 💻 [Usage](#usage)
- 📝 [Contributing](#contributing)
- ⚖️ [License](#license)

[TODO]
## Features

- Ease of Styling: style your component simply by passing props
- Flexible & composable: Interlay UI components are built on top of a React UI
Primitive for endless composability.
- Accessible. Interlay UI components follow the WAI-ARIA guidelines specifications
and have the right `aria-*` attributes by using `react-aria` as foundation.

## Installation

To use Interlay UI components, all you need to do is install the
`@interlay/ui` package and its peer dependencies:

```sh
# with Yarn
$ yarn add @interlay/ui styled-components

# with npm
$ npm i @interlay/ui styled-components

# with pnpm
$ pnpm add @interlay/ui styled-components

# with Bun
$ bun add @interlay/ui styled-components
```

## Usage

To start using the components, please follow these steps:

1. Wrap your application with the `InterlayUIProvider` provided by
**@interlay/ui**.

```jsx
import { InterlayUIProvider } from '@interlay/ui';

// Do this at the root of your application
function App({ children }) {
return <InterlayUIProvider>{children}</InterlayUIProvider>;
}
```

2. Now you can start using components like so!:

```jsx
import { CTA } from '@interlay/ui';

function Example() {
return <CTA>I am using Interlay UI</CTA>;
}
```

## Contributing

Expand Down
11 changes: 11 additions & 0 deletions packages/components/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<p align="center">
<h1 align="center">Interlay UI</h1>
</p>
</br>

Interlay IU is library of accessible, reusable, and composable React components built
around a crypto business model

## More infomation

See [README.md](https://github.com/interlay/ui/blob/master/README.md).
57 changes: 40 additions & 17 deletions packages/components/package.json
Original file line number Diff line number Diff line change
@@ -1,42 +1,50 @@
{
"name": "@just_testing13/components",
"name": "@just_testing13/ui",
"version": "0.1.4",
"description": "Interlay UI library.",
"homepage": "https://github.com/interlay/ui#readme",
"license": "MIT",
"keywords": [
"interlay",
"interlay ui",
"components",
"modern components",
"react components",
"react ui"
],
"main": "src/index.ts",
"files": [
"dist"
],
"license": "MIT",
"sideEffects": false,
"publishConfig": {
"access": "public"
},
"repository": {
"type": "git",
"url": "git+https://github.com/interlay/ui.git",
"directory": "packages/components"
},
"bugs": {
"url": "https://github.com/interlay/ui/issues"
},
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --ext ts,tsx --fix",
"clean": "rimraf dist .turbo",
"typecheck": "tsc --noEmit",
"build": "tsup src/index.ts --dts",
"prepack": "clean-package",
"postpack": "clean-package restore"
},
"devDependencies": {
"@react-types/grid": "^3.2.0",
"@react-types/shared": "^3.19.0",
"@types/react-transition-group": "^4.4.6",
"@types/styled-components": "^5.1.26",
"clean-package": "^2.2.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"styled-components": "^6.0.7"
},
"peerDependencies": {
"react": ">=18",
"react-dom": ">=18",
"styled-components": ">=6.0.0"
},
"dependencies": {
"@just_testing13/hooks": "workspace:*",
"@just_testing13/icons": "workspace:*",
"@just_testing13/coin-icons": "workspace:*",
"@just_testing13/theme": "workspace:*",
"@just_testing13/test-utils": "workspace:*",
"@just_testing13/icon": "workspace:*",
"@just_testing13/system": "workspace:*",
"@react-aria/accordion": "3.0.0-alpha.20",
"@react-aria/breadcrumbs": "^3.5.4",
"@react-aria/button": "^3.8.1",
Expand Down Expand Up @@ -73,5 +81,20 @@
"@react-types/meter": "^3.3.3",
"react-transition-group": "^4.4.5"
},
"peerDependencies": {
"react": ">=18",
"react-dom": ">=18",
"styled-components": ">=6.0.0"
},
"devDependencies": {
"@react-types/grid": "^3.2.0",
"@react-types/shared": "^3.19.0",
"@types/react-transition-group": "^4.4.6",
"@types/styled-components": "^5.1.26",
"clean-package": "^2.2.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"styled-components": "^6.0.7"
},
"clean-package": "../../clean-package.config.json"
}
1 change: 1 addition & 0 deletions packages/components/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,4 @@ export type { TooltipProps } from './Tooltip';
export { Tooltip } from './Tooltip';
export { Icon } from '@just_testing13/icon';
export type { IconProps, IconSize } from '@just_testing13/icon';
export * from '@just_testing13/system';
21 changes: 21 additions & 0 deletions packages/core/system/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# @interlay/system

Interlay UI system primitives, `InterlayUIProvider` and some other utilities.

## Installation

```sh
yarn add @interlay/system
# or
npm i @interlay/system
```

## Contribution

Yes please! See the
[contributing guidelines](https://github.com/interlay/ui/blob/master/CONTRIBUTING.MD)
for details.

## License

[MIT](https://choosealicense.com/licenses/mit/)
35 changes: 27 additions & 8 deletions packages/core/system/package.json
Original file line number Diff line number Diff line change
@@ -1,32 +1,51 @@
{
"name": "@just_testing13/system",
"version": "0.0.0",
"description": "Interlay UI system primitives.",
"homepage": "https://github.com/interlay/ui#readme",
"license": "MIT",
"keywords": [
"interlay",
"interlay ui",
"system"
],
"main": "src/index.ts",
"files": [
"dist"
],
"license": "MIT",
"sideEffects": false,
"publishConfig": {
"access": "public"
},
"repository": {
"type": "git",
"url": "git+https://github.com/interlay/ui.git",
"directory": "packages/core/system"
},
"bugs": {
"url": "https://github.com/interlay/ui/issues"
},
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --ext ts,tsx --fix",
"clean": "rimraf dist .turbo",
"typecheck": "tsc --noEmit",
"build": "tsup src/index.ts --dts",
"prepack": "clean-package",
"postpack": "clean-package restore"
},
"devDependencies": {
"clean-package": "^2.2.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
"dependencies": {
"@react-aria/overlays": "^3.16.0",
"@react-aria/i18n": "^3.8.1"
},
"peerDependencies": {
"react": ">=18",
"react-dom": ">=18"
},
"dependencies": {
"@react-aria/overlays": "^3.16.0",
"@react-aria/i18n": "^3.8.1"
"devDependencies": {
"clean-package": "^2.2.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"clean-package": "../../../clean-package.config.json"
}
21 changes: 21 additions & 0 deletions packages/core/theme/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# @interlay/theme

Interlay UI components theme.

## Installation

```sh
yarn add @interlay/theme
# or
npm i @interlay/theme
```

## Contribution

Yes please! See the
[contributing guidelines](https://github.com/interlay/ui/blob/master/CONTRIBUTING.MD)
for details.

## License

[MIT](https://choosealicense.com/licenses/mit/)
38 changes: 33 additions & 5 deletions packages/core/theme/package.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,53 @@
{
"name": "@just_testing13/theme",
"version": "0.1.3",
"main": "src/index.ts",
"description": "The default theme for Interlay UI components",
"homepage": "https://github.com/interlay/ui#readme",
"license": "MIT",
"keywords": [
"interlay",
"interlay ui",
"theme",
"theming",
"design",
"ui",
"components",
"classNames",
"css"
],
"main": "src/index.ts",
"files": [
"dist"
],
"sideEffects": false,
"publishConfig": {
"access": "public"
},
"repository": {
"type": "git",
"url": "git+https://github.com/interlay/ui.git",
"directory": "packages/core/theme"
},
"bugs": {
"url": "https://github.com/interlay/ui/issues"
},
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint . --ext ts,tsx --fix",
"clean": "rimraf dist .turbo",
"typecheck": "tsc --noEmit",
"build": "tsup",
"prepack": "clean-package",
"postpack": "clean-package restore"
},
"peerDependencies": {
"react": ">=18",
"react-dom": ">=18"
},
"devDependencies": {
"clean-package": "^2.2.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"peerDependencies": {
"react": ">=18",
"react-dom": ">=18"
},
"clean-package": "./clean-package.config.json"
}
Loading

0 comments on commit 879ef90

Please sign in to comment.