Skip to content

Commit e1a7791

Browse files
authored
Chore(docs): Update readme (#38)
* chore(docs): Update readme The `README.md` file still contains old information on how to install the library. All references were updated to `@stackbuilders/react-native-spotlight-tour` to match NPMs registry * chore(docs): Update example imports
1 parent 9bd305c commit e1a7791

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# react-native-spotlight-tour
1+
# React Native Spotlight Tour
22
`react-native-spotlight-tour` is a simple and intuitive library for React Native (Android and iOS
33
compatible). It allows you to implement a highly customizable tour feature with an awesome spotlight
44
effect. This library handles animations at the native level and is perfect for the following:
@@ -16,18 +16,18 @@ effect. This library handles animations at the native level and is perfect for t
1616
## Installation
1717
With `npm`:
1818
```sh
19-
$ npm install react-native-spotlight-tour
19+
$ npm install @stackbuilders/react-native-spotlight-tour
2020
```
2121

2222
With `yarn`:
2323
```sh
24-
$ yarn add react-native-spotlight-tour
24+
$ yarn add @stackbuilders/react-native-spotlight-tour
2525
```
2626

2727
## Basic usage
2828

2929
```tsx
30-
import { AttachStep, SpotlightTourProvider, TourStep } from "react-native-spotligh-tour";
30+
import { AttachStep, SpotlightTourProvider, TourStep } from "@stackbuilders/react-native-spotlight-tour";
3131

3232
const mySteps: TourStep[] = [
3333
...
@@ -136,7 +136,7 @@ import {
136136
Position,
137137
TourStep,
138138
useSpotlightTour
139-
} from "react-native-spotlight-tour";
139+
} from "@stackbuilders/react-native-spotlight-tour";
140140

141141
const mySteps: TourStep[] = [{
142142
alignTo: Align.SCREEN,

example/App.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import dedent from "@cometlib/dedent";
2-
import React, { useState } from "react";
3-
import { Animated, Button, SafeAreaView } from "react-native";
42
import {
53
Align,
64
AttachStep,
75
Position,
86
SpotlightTourProvider,
97
TourStep,
108
useSpotlightTour
11-
} from "react-native-spotlight-tour";
9+
} from "@stackbuilders/react-native-spotlight-tour";
10+
import React, { useState } from "react";
11+
import { Animated, Button, SafeAreaView } from "react-native";
1212

1313
import {
1414
BoldText,

0 commit comments

Comments
 (0)