@audira/carbon-react-native 0.0.1-alpha.2 → 0.0.1-alpha.3

package/README.md

@@ -2,46 +2,56 @@
   Carbon for React Native
 </h1>
 
-> This library is completely rewritten and not intended to be the replacement of the official [carbon-react-native](https://github.com/carbon-design-system/carbon-react-native). It is still in development and far from publish released.
+> This library is completely rewritten and not intended to be the replacement of the official [carbon-react-native](https://github.com/carbon-design-system/carbon-react-native)
+
+> ⚠️ It is still in development
 
 Build React Native apps with component and shared patterns using Carbon.
 
 ## Documentation
 Documentation available with [docusaurus](https://docusaurus.io/) project on this repository under [docs](https://github.com/RakaDoank/carbon-react-native/tree/main/docs) directory. It's not completed yet, even the library, but it will be documented enough, as soon as the library is ready to use. You can start the docs web project with `npm run start` command in the [docs](https://github.com/RakaDoank/carbon-react-native/tree/main/docs) directory.
 
+You can also see the [example](https://github.com/RakaDoank/carbon-react-native/tree/main/example) app.
+
 ## Compatibility
 This library is just a pure JavaScript usage in React Native and only depends on the primitive React Native components with [react-native-reanimated](https://github.com/software-mansion/react-native-reanimated) and [react-native-svg](https://github.com/software-mansion/react-native-svg). It should compatible on all platforms available that can be built with React Native, but i cannot sure that. For the web only, [Carbon React](https://react.carbondesignsystem.com) is already there and do its best and solve a lot of accessibility feature.
 
 ## Installation
 This project is not released yet on npm registry. You have to install it manually,
-1. Clone or Download this repository
-2. Install [pnpm](https://github.com/pnpm/pnpm) package manager if it doesn't exist on your system, and do `pnpm install` in this repoistory
-3. Inside this project, run this command to create actual npm package
+
+With npm
+```
+npm install @audira/carbon-react-native
+```
+
+pnpm
+```
+pnpm install @audira/carbon-react-native
+```
+
+yarn
 ```
-npm run create-package-symlink ../to/your/react-native-project
+yarn add @audira/carbon-react-native
 ```
-Change the path argument, it's relative from this repository lives
 
-5. In your project directory, install the library by this command
-  ```
-  npm install --save ./.carbon-react-native
-  ```
-Ensure it is the correct path.
+### Peer Dependencies
 
-6. Install these dependencies on your React Native project, (skip one of these library if already installed)
+Install these dependencies on your React Native project, (skip one of these library if already installed)
 - [react-native-reanimated](https://github.com/software-mansion/react-native-reanimated)
 - [react-native-svg](https://github.com/software-mansion/react-native-svg)
 - [@carbon/icons](https://www.npmjs.com/package/@carbon/icons)
 - [@carbon/icon-helpers](https://www.npmjs.com/package/@carbon/icon-helpers)
 
-7. Install the `IBM Plex Sans` font to your project with `react-native.config.js` file (create it on your root project directory if doesn't exist)
+### Font Installation
+Install the `IBM Plex Sans` font to your project with [react-native-asset](https://www.npmjs.com/package/react-native-asset). Update your `react-native.config.js` file (create it on your root project directory if doesn't exist)
 ```js
 module.exports = {
   assets: [
-    './node_modules/@rakadoank/carbon-react-native/assets/fonts/',
+    './node_modules/@audira/carbon-react-native/assets/fonts/',
   ],
 }
 ```
+Then, run `npx react-native-asset` to link the fonts
 
 ## Initialize
 This library depends on React Context to use the color tokens correctly based on the current color scheme. You have to wrap your whole React App once with `<CarbonReactNative>`
@@ -49,7 +59,7 @@ This library depends on React Context to use the color tokens correctly based on
 // Somewhere like in your App.tsx file
 import {
   CarbonReactNative,
-} from '@rakadoank/carbon-react-native'
+} from '@audira/carbon-react-native'
 
 export default function App() {
   return (
@@ -66,7 +76,7 @@ Not all components are available yet, but you can test one of this library's com
 ```tsx
 import {
   Button,
-} from '@rakadoank/carbon-react-native'
+} from '@audira/carbon-react-native'
 
 import AddIcon from '@carbon/icons/es/add/20'
 
@@ -91,7 +101,7 @@ import {
 import {
   Text,
   ThemeContext,
-} from '@rakadoank/carbon-react-native'
+} from '@audira/carbon-react-native'
 
 export default function YourReactComponent() {
   const themeContext = useContext(ThemeContext)
@@ -115,7 +125,7 @@ import {
 
 import {
   SpacingConstant,
-} from '@rakadoank/carbon-react-native'
+} from '@audira/carbon-react-native'
 
 export default function YourReactComponent() {
   return (
@@ -143,7 +153,7 @@ If you want override the colorScheme, as an example you only want to use the `gr
 ```tsx
 import {
   CarbonReactNative,
-} from '@rakadoank/carbon-react-native'
+} from '@audira/carbon-react-native'
 
 export default function App() {
   return (
@@ -161,7 +171,7 @@ Not recommended to override the color token that are made by Carbon, but you can
 import {
   CarbonReactNative,
   ColorConstant,
-} from '@rakadoank/carbon-react-native'
+} from '@audira/carbon-react-native'
 
 export default function App() {
   return (
@@ -189,7 +199,7 @@ import {
   CarbonReactNative,
   ColorHelper,
   type ThemeType,
-} from '@rakadoank/carbon-react-native'
+} from '@audira/carbon-react-native'
 
 export default function App() {
   const

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@audira/carbon-react-native",
-  "version": "0.0.1-alpha.2",
+  "version": "0.0.1-alpha.3",
   "type": "module",
   "peerDependencies": {
     "@carbon/icons": ">=11",