Skip to content

Commit

Permalink
Added package versions to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Canciller committed May 2, 2022
1 parent 5a216c7 commit fe4a748
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 24 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# react-native-eyecandy
# React Native Eyecandy

React Native Eyecandy is a library of reusable UI components for React Native, it includes a wide variety of components like buttons, text inputs, icons, and more. The goal of this library is to create a set of reusable components that have a consistent look and feel across different projects. By doing this, we hope to make it easier for React Native developers to create beautiful and user-friendly apps.
React Native Eyecandy is a library of reusable UI components for React Native, it includes a wide variety of components like buttons, text inputs, icons, and more.

The goal of this library is to create a set of reusable components that have a consistent look and feel across different projects. By doing this, we hope to make it easier for React Native developers to create beautiful and user-friendly apps.

## Package Versions

| Name | Latest Version |
| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [@nomada-sh/react-native-eyecandy](/packages/react-native-eyecandy) | [![badge](https://img.shields.io/npm/v/@nomada-sh/react-native-eyecandy.svg?style=flat-square)](https://www.npmjs.com/package/@nomada-sh/react-native-eyecandy) |
| [@nomada-sh/react-native-eyecandy-theme](/packages/react-native-eyecandy-theme) | [![badge](https://img.shields.io/npm/v/@nomada-sh/react-native-eyecandy-theme.svg?style=flat-square)](https://www.npmjs.com/package/@nomada-sh/react-native-eyecandy-theme) |
| [@nomada-sh/react-native-eyecandy-icons](/packages/react-native-eyecandy-icons) | [![badge](https://img.shields.io/npm/v/@nomada-sh/react-native-eyecandy-icons.svg?style=flat-square)](https://www.npmjs.com/package/@nomada-sh/react-native-eyecandy-icons) |

## Installation

Check [getting started](https://eyecandy.nomada.cloud/docs/getting-started#installation) section of our docs for the detailed installation instructions.

## Documentation

Check out our dedicated [documentation](
https://eyecandy.nomada.cloud/docs/components/actionsheet
) page for info about this library, API reference and more.
Check out our dedicated [documentation](https://eyecandy.nomada.cloud/docs/components/actionsheet) page for info about this library, API reference and more.
22 changes: 3 additions & 19 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,21 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
### Installation

```
$ yarn
yarn
```

### Local Development

```
$ yarn start
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

0 comments on commit fe4a748

Please sign in to comment.