Skip to content
This repository has been archived by the owner on May 10, 2023. It is now read-only.

Commit

Permalink
Fix
Browse files Browse the repository at this point in the history
  • Loading branch information
jxom committed Jul 19, 2020
1 parent abec9f8 commit b559706
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Build Status](https://img.shields.io/travis/bumbagui/bumbag.svg?style=flat-square)](https://travis-ci.org/bumbagui/bumbag)
[![NPM](https://img.shields.io/npm/v/bumbag/latest.svg?style=flat-square)](https://www.npmjs.com/package/bumbag)

<p align="center"><img src="./logo.png" width="500px"></img></p>
<p align="center"><img src="./bumbag-logo.png" width="500px"></img></p>

---

Expand All @@ -18,7 +18,7 @@ After some consideration, we decided to rebrand the next major version of "Fanny

## Getting started

[Visit the Bumbag docs](https://v5.bumbag.style) to get started with Bumbag.
[Visit the Bumbag docs](https://bumbag.dev) to get started with Bumbag.

## Contributing

Expand Down
File renamed without changes
2 changes: 1 addition & 1 deletion packages/website/src/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Getting started
path: /getting-started/
---

> Migrating from v4? [Check out the v4 to v5 migration guide](/migrating-from-v4)
> Migrating from Fannypack? [Check out the Fannypack to Bumbag migration guide](/migrating-from-fannypack)
<Box paddingY="major-1" />

Expand Down
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
---
breakpoint: tablet
title: Migrating from v4
path: /migrating-from-v4/
title: Migrating from Fannypack
path: /migrating-from-fannypack/
---

# Migrating from v4
# Migrating from Fannypack

If you are migrating from Bumbag v4, there are quite a few notable breaking changes. This guide aims to help you migrate to v5. If you feel like there is anything missing from this guide, feel free to raise a pull request.
If you are migrating from Fannypack, there are quite a few notable breaking changes. This guide aims to help you migrate to Bumbag. If you feel like there is anything missing from this guide, feel free to raise a pull request.

## Upgrading incrementally

It's recommended to upgrade to v5 incrementally, meaning that v4 and v5 will co-exist until v5 takes over.
It's recommended to upgrade to Bumbag incrementally, meaning that Fannypack and Bumbag will co-exist until Bumbag takes over.

If you wish to upgrade incrementally, you can install the `bumbag-v5` package:
If you wish to upgrade incrementally, you can install the `bumbag` package:

```
npm install bumbag-v5
npm install bumbag
```

And then, set up Bumbag v5 in your app root:
And then, set up Bumbag in your app root:

```jsx
// v5 Bumbag
import { Provider as BumbagProvider } from 'bumbag-v5';
// v4 Bumbag
import { ThemeProvider } from 'bumbag';
// Bumbag
import { Provider as BumbagProvider } from 'bumbag';
// Fannypack
import { ThemeProvider } from 'fannypack';

const oldTheme = { ... };
const newTheme = { ... };
Expand All @@ -41,9 +41,9 @@ const App = () => (
Then you can start incrementally migrating your components like so:

```jsx
- import { Box } from 'bumbag';
+ import { Box } from 'bumbag-v5';
import { Button } from 'bumbag';
- import { Box } from 'fannypack';
+ import { Box } from 'bumbag';
import { Button } from 'fannypack';

function Example() {
return (
Expand All @@ -65,7 +65,7 @@ We have renamed the `<ThemeProvider>` component to `<Provider>`.
##### v4

```jsx
import { ThemeProvider } from 'bumbag';
import { ThemeProvider } from 'fannypack';

const App = () => (
<ThemeProvider>
Expand Down Expand Up @@ -640,7 +640,7 @@ We have moved the `HighlightedCode` component to `bumbag-addon-highlighted-code`
##### v4

```jsx
import { HighlightedCode } from 'bumbag';
import { HighlightedCode } from 'fannypack';
```

##### v5
Expand Down Expand Up @@ -895,7 +895,7 @@ We have moved the `Markdown` component to `bumbag-addon-markdown` to save some b
##### v4

```jsx
import { Markdown } from 'bumbag';
import { Markdown } from 'fannypack';
```

##### v5
Expand Down

0 comments on commit b559706

Please sign in to comment.