Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): usage #1

Merged
merged 2 commits into from
Oct 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 29 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,42 @@ Bringing the web's reset CSS experience to React Native for a consistent mobile

```sh
npm install react-native-reset-css

or

yarn add react-native-reset-css
```

## Usage

### Basic Usage

#### 1. Import the `reset` function

```js
import { multiply } from 'react-native-reset-css';
import { customizeView } from 'react-native-reset-css';

or;

// ...
import Customizer from 'react-native-reset-css';
```

#### 2. Customize your Component

const result = await multiply(3, 7);
```js
customizeView({
style: {
backgroundColor: 'blue',
},
});

or;

Customizer.View({
style: {
backgroundColor: 'yellow',
},
});
```

## Contributing
Expand All @@ -25,7 +51,3 @@ See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the
## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-native-reset-css",
"version": "0.1.0",
"version": "0.2.0",
"description": "Bringing the web's reset CSS experience to React Native for a consistent mobile UI",
"main": "lib/commonjs/index",
"module": "lib/module/index",
Expand Down
Loading