docs/readme: update readme

This commit is contained in:
rr- 2016-04-13 13:09:40 +02:00
parent b7a67fc01c
commit 450b9bf504

View file

@ -1,19 +1,18 @@
This is rewrite of [`szurubooru` 0.9.x](https://github.com/rr-/szurubooru) that
intends to:
This repository is under the process of being rewritten. Stay tuned! You can
check the current progress at the
[roadmap](https://github.com/rr-/szurubooru/wiki/Roadmap).
- Improve user experience: better upload form, larger thumbnails, make top
The reasons behind this rewrite include:
- Improving user experience: better upload form, larger thumbnails, making top
navigation stay out of user way. Maybe other goodies!
- Finally define sane REST API without unnecessary blobs and with proper
documentation.
- Simplify registration - user registers, and they're able to post. (You'll
still be able to make it kind of invite-only via default permissions.)
- Replace PHP with Python 3.5.
- Replace prior JS mess with proper MVC.
- Replace MySQL (MariaDB) with Postgres.
- Replace `composer`, `npm`, `mod_rewrite` (=Apache), `imagick`, `pdo_mysql`
with just `pip` and `npm` (+ sandboxed dependencies).
- Replace `grunt` with `npm` scripts.
- Make hosting more flexible: offer simple self hosted app that can be combined
with any reverse proxy.
- Reduce codebase size - the original szurubooru was at 30KSLOC (`git
line-summary`), let's see how much this can be brought down.
- Finally having good, well-documented REST API.
- Simplifying user registration.
- Replacing PHP with Python 3.5.
- Replacing prior JS mess with proper MVC.
- Replacing MySQL (MariaDB) with Postgres.
- Replacing `composer`, `npm`, `mod_rewrite` (=Apache), `imagick`, `ffmpeg` or
`gnash` and `pdo_mysql` with just `pip`, `npm` and `ffmpeg`.
- Replacing `grunt` with `npm` scripts.
- Making hosting more flexible: offer simple self hosted application that can
be combined with any reverse proxy.