diff --git a/README.md b/README.md index fb5fcf1..1ed935f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ -# NativeFlow +
-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. + Display Name + +

+ 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. +

+ +
## Installation @@ -8,22 +14,7 @@ A utility-first CSS-in-JS framework tailored for React Native, offering a rich s npm install nativeflowcss ``` -## Usage - -```js -import { p, m, flex, border } from 'nativeflowcss'; - -// ... -; -``` +> For comprehensive Guide on NativeFlow, Read our [Documentation](https://nativeflow.js.org) ## Contributing diff --git a/assets/display-name.svg b/assets/display-name.svg new file mode 100644 index 0000000..7bb0491 --- /dev/null +++ b/assets/display-name.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..ca5db38 Binary files /dev/null and b/assets/logo.png differ diff --git a/package.json b/package.json index 8c527d6..8a63c5e 100644 --- a/package.json +++ b/package.json @@ -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": { @@ -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" @@ -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 (https://github.com/nativeflowcrafts)", + "author": "Jay Singh (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/" },