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

chore: readme update #11

Merged
merged 1 commit into from
Mar 4, 2024
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
48 changes: 43 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,53 @@ npm install reactnatively

## Usage

## Components

Avatars
Avatars can be used to display user profile pictures or text representations.

```js
import { Avatar, TextAvatar } from 'reactnatively';

// ...

const AvatarComponent = () => {
return (
<Avatar size={42} src="https://example.com/avatar.jpg" />
<TextAvatar size={50} text="HF" bg="blue" />
);
```

Heading
Heading components render text headings with customizable sizes.

```js
import { Heading } from 'reactnatively';

// ...

const HeaderComponent = () => {
return (
<Heading variant="h1">Main Heading</Heading>
<Heading variant="h3">Subheading</Heading>
);
```

Button
Buttons provide interactive elements for triggering actions.

```js
import { Wrapper, Text, Heading } from 'reactnatively';
import { Button } from 'reactnatively';

// ...

<Wrapper>
<Text>Hello</Text>
<Heading variant="h2">Welcome</Heading>
</Wrapper>
const ButtonExample = () => {
return (
<Button size="lg" onPress={() => console.log('Button clicked')}>
Click Me
</Button>
);
};
```

## Contributing
Expand Down
2 changes: 1 addition & 1 deletion example/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export default function App() {
{/* <TextTabs
tabs={[{ name: 'Post' }, { name: 'Settings' }, { name: 'Upload' }]}
/> */}
<Button size="xs" bg="violet" color="yellow">
<Button size="lg" bg="black" color="white">
hi
</Button>
</Wrapper>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "reactnatively",
"version": "0.1.4",
"version": "0.1.5",
"description": "reactnatively is a lightweight and minimal UI library designed for simplicity and flexibility. It provides essential components and styles to kickstart your React Native projects without unnecessary bloat.",
"main": "lib/commonjs/index",
"module": "lib/module/index",
Expand Down
Binary file removed reactnatively-0.1.2.tgz
Binary file not shown.
Binary file removed reactnatively-0.1.3.tgz
Binary file not shown.
Binary file modified reactnatively-0.1.4.tgz
Binary file not shown.
Loading