Skip to content

Commit

Permalink
feat: Improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
linc committed Mar 2, 2024
1 parent 7b41e09 commit 56cf161
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 28 deletions.
52 changes: 24 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,36 @@ Nitro Porter 🚀

The only multi-platform community migration tool. Free your forum!

Currently [exports](https://nitroporter.org/targets) to:
* Flarum
* Vanilla
* Waterhole

Currently imports from:
* Flarum
* Vanilla
* vBulletin
* XenForo
* phpBB
* IPBoard
* Simple Machines (SMF)
* Drupal
* NodeBB
* FluxBB
* ...and [more than a dozen more](https://nitroporter.org/sources)!

Click the links for a list of supported features for each platform. Both the source and target must support a feature for the data to transfer.
Nitro Porter is based on PHP 8.0+. For the full requirements, see the [user guide](https://nitroporter.org/guide).

## Getting Started

## Requirements
Nitro Porter runs via the command line. For the installation steps, see the [user guide](https://nitroporter.org/guide).

Nitro Porter is based on PHP 8.0+. For the full requirements, see the [user guide](https://nitroporter.org/guide).
## Supported Software

Supported [targets](https://nitroporter.org/targets):

## Getting Started
![](assets/logos/flarum-300x100.png)
![](assets/logos/vanilla-300x100.png)
![](assets/logos/waterhole-300x100.png)

Nitro Porter runs via the command line. For the installation steps, see the [user guide](https://nitroporter.org/guide).
Supported [sources](https://nitroporter.org/sources):
* Drupal
* Flarum
* FluxBB
* IPBoard
* NodeBB
* phpBB
* Simple Machines (SMF)
* Vanilla
* vBulletin
* XenForo
* _...and [MANY MORE](https://nitroporter.org/sources)!_

Follow the above links for a list of **supported features per platform**. Both the source and target must support a feature for the data to transfer.

## Contribute
## How to Contribute

### Data!

Expand All @@ -46,10 +44,8 @@ We greatly appreciate donated data from existing forums to improve the migration

### Submit a fix or improvement

Send a pull request with a proposed fix! It's greatly appreciated. Please document your understanding of the change, it makes review much easier!

Try using [conventional commits](https://www.conventionalcommits.org) for a nicer changelog.
Send a pull request with a proposed fix! It's greatly appreciated. Please document your understanding of the change, it makes review much easier! Try using [conventional commits](https://www.conventionalcommits.org) for a nicer changelog.

### Add support for a new source

Check the [developer guide](https://nitroporter.org/develop) for info on extending Nitro Porter.
Check the [developer guide](https://nitroporter.org/develop) for info on extending Nitro Porter to support a new source or target.
Binary file added assets/logos/flarum-300x100.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/logos/vanilla-300x100.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/logos/waterhole-300x100.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 56cf161

Please sign in to comment.