Skip to content

Commit

Permalink
Update branch name in links
Browse files Browse the repository at this point in the history
  • Loading branch information
elrumordelaluz committed Aug 28, 2022
1 parent 41a9701 commit d2813a4
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 20 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ This project and everyone participating in it is governed by the [Code of Conduc

Since `v2`, Reactour ships separated scoped packages:

- [@reactour/tour](https://github.com/elrumordelaluz/reactour/tree/master/packages/tour) - The main package, which uses the other ones to highlight parts of your application from an array of steps.
- [@reactour/mask](https://github.com/elrumordelaluz/reactour/tree/master/packages/mask) - A customizable Component to highlight certain element or area of the viewport.
- [@reactour/popover](https://github.com/elrumordelaluz/reactour/tree/master/packages/popover) - A customizable Component to attach to an element or position of the viewport to show content.
- [@reactour/utils](https://github.com/elrumordelaluz/reactour/tree/master/packages/utils) - A set of helper functions used by the other packages.
- [@reactour/playground](https://github.com/elrumordelaluz/reactour/tree/master/packages/playground) - The place where all the stuff is visible working.
- [@reactour/tour](https://github.com/elrumordelaluz/reactour/tree/main/packages/tour) - The main package, which uses the other ones to highlight parts of your application from an array of steps.
- [@reactour/mask](https://github.com/elrumordelaluz/reactour/tree/main/packages/mask) - A customizable Component to highlight certain element or area of the viewport.
- [@reactour/popover](https://github.com/elrumordelaluz/reactour/tree/main/packages/popover) - A customizable Component to attach to an element or position of the viewport to show content.
- [@reactour/utils](https://github.com/elrumordelaluz/reactour/tree/main/packages/utils) - A set of helper functions used by the other packages.
- [@reactour/playground](https://github.com/elrumordelaluz/reactour/tree/main/packages/playground) - The place where all the stuff is visible working.

Nothing prevents us to continue improving this scoped list, so again thanks for your contribution.

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img alt="reactour" title="reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/master/logo.svg" width="250">
<img alt="reactour" title="reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/main/logo.svg" width="250">
</p>
<p align="center" style="margin-top: 40px">
<strong>Tourist Guide</strong> and a set of <strong>Assistants</strong> to travel into your React Components
Expand All @@ -9,23 +9,23 @@

> This documentation is for the latest release, which uses [npm scoped package](https://docs.npmjs.com/cli/v7/using-npm/scope) `@reactour`. The original `reactour` is now on branch `v1` and its documentation can be found [here](https://github.com/elrumordelaluz/reactour/tree/v1).
### [@reactour/tour](https://github.com/elrumordelaluz/reactour/tree/master/packages/tour)
### [@reactour/tour](https://github.com/elrumordelaluz/reactour/tree/main/packages/tour)

The main package, which uses the other ones to highlight parts of your application from an array of steps.

### [@reactour/mask](https://github.com/elrumordelaluz/reactour/tree/master/packages/mask)
### [@reactour/mask](https://github.com/elrumordelaluz/reactour/tree/main/packages/mask)

A customizable Component to highlight certain element or area of the viewport.

### [@reactour/popover](https://github.com/elrumordelaluz/reactour/tree/master/packages/popover)
### [@reactour/popover](https://github.com/elrumordelaluz/reactour/tree/main/packages/popover)

A customizable Component to attach to an element or position of the viewport to show content.

### [@reactour/utils](https://github.com/elrumordelaluz/reactour/tree/master/packages/utils)
### [@reactour/utils](https://github.com/elrumordelaluz/reactour/tree/main/packages/utils)

A set of helper functions used by the other packages.

### [@reactour/playground](https://github.com/elrumordelaluz/reactour/tree/master/packages/playground)
### [@reactour/playground](https://github.com/elrumordelaluz/reactour/tree/main/packages/playground)

The place where all the stuff is visible working, live [here](https://reactour.vercel.app/).

Expand Down
4 changes: 2 additions & 2 deletions packages/mask/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img alt="Reactour" title="Reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/master/packages/mask/logo.svg" width="400">
<img alt="Reactour" title="Reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/main/packages/mask/logo.svg" width="400">
</p>
<p align="center">
An SVG mask that cover all the window contents except the one specified by certain position and sizes values
Expand Down Expand Up @@ -111,7 +111,7 @@ Prop to customize styles for the different parts of the _Mask_ using a function
```js
const styles = {
maskWrapper: base => ({
maskWrapper: (base) => ({
...base,
color: 'red',
}),
Expand Down
6 changes: 3 additions & 3 deletions packages/popover/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img alt="Reactour" title="Reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/master/packages/popover/logo.svg" width="400">
<img alt="Reactour" title="Reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/main/packages/popover/logo.svg" width="400">
</p>
<p align="center">
A popover positioned based on certain values
Expand Down Expand Up @@ -106,13 +106,13 @@ Prop to customize styles for the different parts of the _Mask_ using a function
### `refresher?: any`
Any value that if changed, updates [rect](https://github.com/elrumordelaluz/reactour/tree/master/packages/utils#refresher-any) calculations
Any value that if changed, updates [rect](https://github.com/elrumordelaluz/reactour/tree/main/packages/utils#refresher-any) calculations
#### Example
```js
const styles = {
popover: base => ({
popover: (base) => ({
...base,
boxShadow: '0 0 3em rgba(0, 0, 0, 0.5)',
backgroundColor: '#dedede',
Expand Down
6 changes: 3 additions & 3 deletions packages/tour/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<a href="reactour.js.org">
<img alt="Reactour" title="Reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/master/logo.svg" width="250"></a>
<img alt="Reactour" title="Reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/main/logo.svg" width="250"></a>
</p>
<p align="center" style="margin-top: 40px;margin-bottom: 40px;">
<strong>Tourist Guide</strong> into your React Components
Expand Down Expand Up @@ -64,7 +64,7 @@ function App() {

#### Playground

The [Playground](https://github.com/elrumordelaluz/reactour/tree/master/packages/playground) is the perfect place to play aroud with all `@reactour` _Components_. [Here](https://reactour.vercel.app) is an online version.
The [Playground](https://github.com/elrumordelaluz/reactour/tree/main/packages/playground) is the perfect place to play aroud with all `@reactour` _Components_. [Here](https://reactour.vercel.app) is an online version.

#### Sandboxes

Expand Down Expand Up @@ -208,7 +208,7 @@ Prop to customize styles for the different parts of the _Mask_, _Popover_ and _T

#### Style keys and props available

Refer to [Mask docs](https://github.com/elrumordelaluz/reactour/tree/master/packages/mask) and [Popover docs](https://github.com/elrumordelaluz/reactour/tree/master/packages/popover) for its specific Components
Refer to [Mask docs](https://github.com/elrumordelaluz/reactour/tree/main/packages/mask) and [Popover docs](https://github.com/elrumordelaluz/reactour/tree/main/packages/popover) for its specific Components

##### Tour Components

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img alt="Reactour" title="Reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/master/packages/utils/logo.svg" width="400">
<img alt="Reactour" title="Reactour" src="https://raw.githubusercontent.com/elrumordelaluz/reactour/main/packages/utils/logo.svg" width="400">
</p>
<p align="center">
A set of utilities used by <code>@reactour</code> packages
Expand Down

0 comments on commit d2813a4

Please sign in to comment.