Skip to content

Commit

Permalink
chore: rewrite README
Browse files Browse the repository at this point in the history
  • Loading branch information
mathdebate09 committed Sep 10, 2024
1 parent 9bfd8f4 commit 94a2ab2
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 25 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,20 @@
# NativeFlow
<div align="center">

A utility-first CSS-in-JS framework tailored for React Native, offering a rich set of utilities such as `flex.justify('center')`, `m.b(4)`, and `border.color('#cccccc')`. These utilities can be composed to create any design, similar to the approach used by Tailwind CSS.
<img src="./assets/display-name.svg" alt="Display Name">

<p>
A utility-first styling object library tailored for React Native, offering a rich set of utilities such as `justify-center`, `m.b_(4)`, and `bdr.color_slate_200`. These utilities can be composed to create any design, similar to the approach used by Tailwind.
</p>

</div>

## Installation

```sh
npm install nativeflowcss
```

## Usage

```js
import { p, m, flex, border } from 'nativeflowcss';

// ...
<View
style={[
flex.row,
flex.justify('around'),
flex.gap(12),
flex.items('center'),
flex.f(1),
]}
></View>;
```
> For comprehensive Guide on NativeFlow, Read our [Documentation](https://nativeflow.js.org)
## Contributing

Expand Down
15 changes: 15 additions & 0 deletions assets/display-name.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "nativeflowcss",
"version": "1.0.0",
"description": "A utility-first CSS-in-JS framework tailored for React Native, offering a rich set of utilities such as flex.justify('center'), m.b(4), and`border.color('#cccccc'). These utilities can be composed to create any design, similar to the approach used by Tailwind CSS.",
"source": "./src/index.tsx",
"version": "1.1.10",
"description": "A utility-first styling objects for React Native, syntax similar to Tailwind.",
"source": "./src/index.ts",
"main": "./lib/commonjs/index.js",
"module": "./lib/module/index.js",
"exports": {
Expand Down Expand Up @@ -39,7 +39,7 @@
"example": "npm run example --workspace=example",
"test": "jest",
"typecheck": "tsc",
"lint": "eslint \"**/*.{js,ts,tsx}\"",
"lint": "eslint \"**/*.{js,ts}\"",
"clean": "del-cli lib",
"prepare": "bob build",
"release": "release-it"
Expand Down Expand Up @@ -75,14 +75,14 @@
],
"repository": {
"type": "git",
"url": "git+https://github.com/nativeflowcrafts/nativeflowcss.git"
"url": "git+https://github.com/nativeflowteam/nativeflowcss"
},
"author": "Jay Singh <[email protected]> (https://github.com/nativeflowcrafts)",
"author": "Jay Singh <[email protected]> (https://github.com/nativeflowteam)",
"license": "MIT",
"bugs": {
"url": "https://github.com/nativeflowcrafts/nativeflowcss/issues"
},
"homepage": "https://github.com/nativeflowcrafts/nativeflowcss#readme",
"homepage": "https://nativeflow.js.org",
"publishConfig": {
"registry": "https://registry.npmjs.org/"
},
Expand Down

0 comments on commit 94a2ab2

Please sign in to comment.