Skip to content

Commit 6185821

Browse files
committed
added more docs and fixed website bugs
1 parent db594d1 commit 6185821

8 files changed

Lines changed: 45 additions & 2 deletions

File tree

docs/hasEnrolledFingerprints.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,10 @@ title: hasEnrolledFingerprints
44
sidebar_label: hasEnrolledFingerprints
55
---
66

7+
Checks the enrollment status of fingerprints on the device. It will return `true` if detected otherwise returns `false`
8+
9+
```
10+
import RNSInfo from 'react-native-sensitive-info';
11+
12+
SINFo.hasEnrolledFingerprints();
13+
```

docs/isHardwareDetected.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,11 @@ title: isHardwareDetected
44
sidebar_label: isHardwareDetected
55
---
66

7+
Checks if user's phone has fingerprint hardware. It will return `true` if detected otherwise returns `false`
8+
9+
```
10+
import RNSInfo from 'react-native-sensitive-info';
11+
12+
SINFo.isHardwareDetected();
13+
```
14+

docs/isSensorAvailable.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,10 @@ title: isSensorAvailable
44
sidebar_label: isSensorAvailable
55
---
66

7+
Indicates the overall availability of fingerprint sensor. It is the same as using **[hasEnrolledFingerprints](./hasEnrolledFingerprints)** and **[isHardwareDetected](./isHardwareDetected)**. It will resolve to `true` or `false`
8+
9+
```
10+
import RNSInfo from 'react-native-sensitive-info';
11+
12+
SINFo.isSensorAvailable();
13+
```

docs/overview.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
id: overview
3+
title: Overview
4+
sidebar_label: Overview
5+
---
6+
7+
RNSInfo is an open-source library developed by many contributors since 2016. ❤️
8+
9+
Securing sensitive data is very important in production-ready applications. So, this is why RNSInfo was created for, to help you focus in what matters most, your application. 😉
10+
11+
Handling sensitive data couldn't be easier in React-Native apps.

docs/setItem.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,9 @@ title: setItem
44
sidebar_label: setItem
55
---
66

7+
8+
**WIP**
9+
10+
In the meantime checkout our **[README](https://github.com/mCodex/react-native-sensitive-info#methods)** for further information.
11+
12+
Wanna help? Just send a PR 😉

website/i18n/en.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@
2121
"title": "isSensorAvailable",
2222
"sidebar_label": "isSensorAvailable"
2323
},
24+
"overview": {
25+
"title": "Overview",
26+
"sidebar_label": "Overview"
27+
},
2428
"setItem": {
2529
"title": "setItem",
2630
"sidebar_label": "setItem"

website/pages/en/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ class HomeSplash extends React.Component {
6363
<div className="inner">
6464
<ProjectTitle tagline={siteConfig.tagline} title={siteConfig.title} />
6565
<PromoSection>
66-
<Button href="/docs/installation">GET STARTED</Button>
66+
<Button href="docs/installation">GET STARTED</Button>
6767
{/* <Button href="/docs/installation">API</Button> */}
6868
</PromoSection>
6969
</div>

website/sidebars.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"docs": {
3-
"Introduction": ["installation"],
3+
"Introduction": ["overview", "installation"],
44
"API": [
55
"hasEnrolledFingerprints",
66
"isHardwareDetected",

0 commit comments

Comments
 (0)