Skip to content

Commit

Permalink
Merge pull request #13 from nibgat/develop
Browse files Browse the repository at this point in the history
Release: v1.0.1
  • Loading branch information
lfabl committed Sep 16, 2022
2 parents 2c24e2b + 79e68e9 commit 24b1a7e
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 19 deletions.
73 changes: 55 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,68 @@
# ncore-mobile
<p align="center">
<img
width="450"
height="450"
src="https://ncore.nibgat.space/assets/images/darklogo.png"
/>
<br/>
<span style="font-size: 24px; font-weight: bold; text-align: center; width: 100%;">NİBGAT® | NCore Mobile Component Library</span>
<br/>
<br/>
</p>

NİBGAT® | NCore Mobile Component Library
### Documentation

## Installation
Please visit for docs: [NCore Mobile](https://ncore.nibgat.space/mobile)

```sh
npm install ncore-mobile react-native-gesture-handler react-native-modalize react-native-portalize react-native-svg react-native-simple-toast
```
or
```sh
yarn add ncore-mobile
```
### Dependencies

If you install with yarn these packages will already be installed.

- immer@9.0.12
- react-native-gesture-handler@2.3.2
- react-native-modalize@2.0.13
- react-native-portalize@1.0.7
- react-native-simple-toast@1.1.3
- react-native-svg@12.3.0

### Base Library

## Usage
- The library is exporting sample base components to be used in react project you can test it like this :
- NPM: `npm install ncore-mobile react-native-gesture-handler react-native-modalize react-native-portalize react-native-svg react-native-simple-toast --save`
- YARN: `yarn add ncore-mobile`

```js
import {
NCoreProvider
} from "ncore-mobile";
NCoreProvider,
useNCoreTheme,
Button
} from 'ncore-mobile';

const Home = () => {
const {
activeTheme,
colors
} = useNCoreTheme();

return <View
style={{
backgroundColor: colors.background,
justifyContent: "center",
alignItems: "center",
flex: 1
}}
>
Welcome to Home Page. Your theme is: {activeTheme}
</View>;
};

const App = () => {
return <NCoreProvider>
{...your project codes. ( navigation, etc. )}
</NCoreProvider>
};
{your project codes... (navigation, etc.)}
</NCoreProvider>;
}
```

## License
### Discord

MIT
<a href="https://discord.gg/fMgVPZknuM">NİBGAT® | Community</a>
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ncore-mobile",
"version": "1.0.0",
"version": "1.0.1",
"description": "NİBGAT® | NCore Mobile Component Library",
"main": "lib/commonjs/index",
"module": "lib/module/index",
Expand Down

0 comments on commit 24b1a7e

Please sign in to comment.