Skip to content

Commit

Permalink
Update README for 2025
Browse files Browse the repository at this point in the history
  • Loading branch information
linc committed Dec 29, 2024
1 parent e2f4027 commit 4d7d590
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,49 +3,59 @@ Nitro Porter 🚀

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

Nitro Porter is based on PHP 8.0+. For the full requirements, see the [user guide](https://nitroporter.org/guide).
Nitro Porter is based on PHP 8.0+ and runs via the command line.
For the full requirements and installation steps, see the [user guide](https://nitroporter.org/guide).

## Getting Started
If you run into problems, check the logs & [start a discussion on GitHub](https://github.com/linc/nitro-porter/discussions).
Check the [changelog](https://github.com/linc/nitro-porter/blob/main/CHANGELOG.md) for the latest fixes & updates.

Nitro Porter runs via the command line. For the installation steps, see the [user guide](https://nitroporter.org/guide).
## What's Supported So Far?

## Supported Software

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

![Flarum](assets/logos/flarum-300x100.png)
![Vanilla](assets/logos/vanilla-300x100.png)
![Waterhole](assets/logos/waterhole-300x100.png)

Supported [sources](https://nitroporter.org/sources):
### [Supported Sources](https://nitroporter.org/sources) (37)
* bbPress
* Drupal
* Flarum
* FluxBB
* IPBoard
* MyBB
* NodeBB
* phpBB
* Simple Machines (SMF)
* Vanilla
* vBulletin
* XenForo
* _...and [MANY MORE](https://nitroporter.org/sources)!_
* _...[and 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.

Don't see your software? [Start a discussion](https://github.com/linc/nitro-porter/discussions/new) to request it and keep an eye on our [informal roadmap](https://github.com/users/linc/projects/2).

## How to Contribute

### Data!
In ascending order of effort:

### Send data!

We greatly appreciate donated data from existing forums to improve the migration and its testing (using partial, anonymized records). A complete database dump is best way to do this. We protect privacy, but you're welcome to anonymize personally-identifiable information first. Willing to sign an extremely narrow NDA for the purpose if necessary. Contact lincoln@icrontic.com.

### Document a bug
### Report a problem

[Start a discussion](https://github.com/linc/nitro-porter/discussions/new) if you've hit a problem, including as much detail as possible and any error message or logs available. We don't currently maintain a formal issue tracker.

### Report a _success_!

[Start a discussion](https://github.com/linc/nitro-porter/discussions/new) if you've found a reproducible defect. Please include expected vs actual outcome and full steps to reproduce it reliably. We don't currently maintain an issue tracker.
Did you successfully use Nitro Porter? [Start a discussion](https://github.com/linc/nitro-porter/discussions/new) to tell us all about it! What platforms were you migrating between and how much data was involved? Was it confusing at all?

### 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.

### Add support for a new source
### Add support for a new source or target

Check the [developer guide](https://nitroporter.org/develop) for info on extending Nitro Porter to support a new source or target.
Check the [developer guide](https://nitroporter.org/develop) for info on extending Nitro Porter to support a new source or target. It's pretty straightforward!

0 comments on commit 4d7d590

Please sign in to comment.