Skip to content

Commit

Permalink
Merge pull request #11 from hakizimana-fred/staging
Browse files Browse the repository at this point in the history
chore: readme update
  • Loading branch information
hakizimana-fred authored Mar 4, 2024
2 parents 973f5d3 + 7579761 commit fc42421
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 7 deletions.
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.

0 comments on commit fc42421

Please sign in to comment.