Skip to content

Commit

Permalink
Chore(docs): Update readme (#38)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
JoseLion committed Jun 1, 2021
1 parent 9bd305c commit e1a7791
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# react-native-spotlight-tour
# React Native Spotlight Tour
`react-native-spotlight-tour` is a simple and intuitive library for React Native (Android and iOS
compatible). It allows you to implement a highly customizable tour feature with an awesome spotlight
effect. This library handles animations at the native level and is perfect for the following:
Expand All @@ -16,18 +16,18 @@ effect. This library handles animations at the native level and is perfect for t
## Installation
With `npm`:
```sh
$ npm install react-native-spotlight-tour
$ npm install @stackbuilders/react-native-spotlight-tour
```

With `yarn`:
```sh
$ yarn add react-native-spotlight-tour
$ yarn add @stackbuilders/react-native-spotlight-tour
```

## Basic usage

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

const mySteps: TourStep[] = [
...
Expand Down Expand Up @@ -136,7 +136,7 @@ import {
Position,
TourStep,
useSpotlightTour
} from "react-native-spotlight-tour";
} from "@stackbuilders/react-native-spotlight-tour";

const mySteps: TourStep[] = [{
alignTo: Align.SCREEN,
Expand Down
6 changes: 3 additions & 3 deletions example/App.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import dedent from "@cometlib/dedent";
import React, { useState } from "react";
import { Animated, Button, SafeAreaView } from "react-native";
import {
Align,
AttachStep,
Position,
SpotlightTourProvider,
TourStep,
useSpotlightTour
} from "react-native-spotlight-tour";
} from "@stackbuilders/react-native-spotlight-tour";
import React, { useState } from "react";
import { Animated, Button, SafeAreaView } from "react-native";

import {
BoldText,
Expand Down

0 comments on commit e1a7791

Please sign in to comment.