Skip to content

Commit

Permalink
docs: Emojify the README
Browse files Browse the repository at this point in the history
  • Loading branch information
linc committed Dec 30, 2024
1 parent 5d2edc5 commit 3484972
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,26 @@ Nitro Porter is based on PHP 8.2+ and runs via the command line.

## Documentation

### Getting started
### 🚥 Get started

* [User Guide](https://nitroporter.org/guide) for requirements & install steps.
* [Migration Guide](https://nitroporter.org/migrations) to plan a community migration.
* [Sources](https://nitroporter.org/sources) & [Targets](https://nitroporter.org/targets) detail what's supported.
* [Start a Discussion](https://github.com/linc/nitro-porter/discussions) to share how it went.
* [**User Guide**](https://nitroporter.org/guide) for requirements & install steps.
* [**Migration Guide**](https://nitroporter.org/migrations) to plan a community migration.
* [**Sources**](https://nitroporter.org/sources) & [**Targets**](https://nitroporter.org/targets) detail what's supported.
* [**Start a Discussion**](https://github.com/linc/nitro-porter/discussions) to share how it went.

### Getting involved
### 🎟️ Get involved

* [Contribute](docs/contribute.md) data, requests, fixes, or success stories.
* [Changelog](CHANGELOG.md) has latest fixes & updates.
* [Roadmap](https://github.com/users/linc/projects/2) contains informal goals, not ETAs.
* [History](docs/history.md) gives more context to the project.
* [**Contribute**](docs/contribute.md) data, requests, fixes, or success stories.
* [**Changelog**](CHANGELOG.md) has latest fixes & updates.
* [**Roadmap**](https://github.com/users/linc/projects/2) contains informal goals, not ETAs.
* [**History**](docs/history.md) gives more context to the project.

### Mission statement
### 🚀 Mission statement

Community history is vitally important, and being able to change software is important for the health of the ecosystem.
However, community software often has high lock-in due to the difficulty of a data migration.

Nitro Porter exists because your community deserves both the best tools available and its unique history.
Nitro Porter exists because your community deserves to both use the best tools available and preserve its unique history.

This tool is designed for ease of extensibility to allow anyone with basic programming skills to add a source or target.
Any generally available forum software (commercial or free) may be added as a source or target.
Expand All @@ -35,15 +35,15 @@ It does not include bespoke or custom forum software, but is designed to allow i
Nitro Porter uses the [GNU AGPL 3.0 license](COPYING) to ensure it remains freely available to anyone who needs it.
That means code for all new packages written for it must likewise be made freely available.

## What's Supported So Far?
## What's Supported?

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

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

### Sources ([37](https://nitroporter.org/sources))
### 📤 Sources ([37](https://nitroporter.org/sources))
* bbPress
* Drupal
* Flarum
Expand All @@ -58,7 +58,7 @@ That means code for all new packages written for it must likewise be made freely
* XenForo
* _...[and MORE](https://nitroporter.org/sources)!_

### What gets migrated?
### What data gets migrated?

All sources & targets support migrating:
* users & roles
Expand All @@ -74,7 +74,7 @@ These include things like badges, reactions, bookmarks, and polls.
Nitro Porter **never** transfers permissions. It's not safe to do so automatically due to variations in how platforms implement them.
You will **always** need to reassign permissions after a migration.

### Future support
### 🔭 Future support

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).
We're happy to add a new **Source** for any software, provided it is not bespoke.
Expand Down

0 comments on commit 3484972

Please sign in to comment.