Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sokdaracheng committed May 21, 2021
1 parent cc4aeaf commit 63cc29b
Show file tree
Hide file tree
Showing 3 changed files with 316 additions and 298 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,38 @@
# @chengsokdara/react-native-cosmotize
# react-native-cosmotize

React Native direct prop styling, inspired by Tailwindcss.

## Installation

```sh
yarn add @chengsokdara/react-native-cosmotize

npm install @chengsokdara/react-native-cosmotize
```

## Usage

```js
import ReactNativeCosmotize from "@chengsokdara/react-native-cosmotize";
```tsx
import { View } from '@chengsokdara/react-native-cosmotize';
import Box from '@chengsokdara/react-native-cosmotize';

export default function App() {
return (
<View flex-1 items-center justify-center bg-black>
<Box bg-white width-100 height-100 />
</View>
);
}
```

### API

// ...
Layout and View Style props are implemented.
[React Native Layout Props](https://reactnative.dev/docs/layout-props)
[React Native View Style Props](https://reactnative.dev/docs/view-style-props)

const result = await ReactNativeCosmotize.multiply(3, 7);
```
Please refer to Tailwindcss documentation for available prop name.
[Tailwindcss Docs](https://tailwindcss.com/docs)

## Contributing

Expand Down
1 change: 1 addition & 0 deletions src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import React from 'react';
import { View as RNView, ViewStyle } from 'react-native';

import { EColors } from './enums';
import type { IViewProps } from './types';
import { isNumeric } from './utils';

/**
Expand Down
Loading

0 comments on commit 63cc29b

Please sign in to comment.