diff --git a/README.MD b/README.MD index ad83487..8edc365 100755 --- a/README.MD +++ b/README.MD @@ -10,84 +10,30 @@ The word _Jikan_ literally translates to _Time_ in Japanese (**時間**). And th **Notice**: Jikan does not support authenticated requests. You can not update your lists. Use the official MyAnimeList API for this. -## Index -- [What's new?](#whats-new) -- [Getting Started](#getting-started) - - [Requirements](#requirements) - - [🐳 Docker](#-docker) - - [Installation Prerequisites](#01-installation-prerequisites) - - [Installation](#02-installation) - - [Configuration](#03-configuration) - - [Ignition](#04-ignition) - - [Configuring Cache Driver](#05-configuring-how-jikan-caches-optional) (optional) - - [Configuring Cache Method](#06-configuring-how-jikan-handles-expired-cache-optional) (optional) - - [Configuring Supervisord](#configuring-supervisord) (optional) -- [Troubleshooting](#troubleshooting) -- [Artisan Commands](#artisan-commands) -- [Information](#information) -- [Wrappers](#wrappers) -- [Running Tests](#running-tests) -- [Backers](#backers) -- [Disclaimer](#disclaimer) -## What's new? +## Installation +Please read the [manual installation guide](https://github.com/jikan-me/jikan-rest/wiki). +For any additional help, join our [Discord server](http://discord.jikan.moe/). -## Getting Started +### 🐳 Docker Installation +If you don't want to install it manually, you can use the [docker image](https://github.com/jikan-me/jikan-docker) -### Requirements - -- PHP ^7.4 -- [Composer](https://getcomposer.org/download/) -- [MongoDB]() - - -## Getting started - -### Requirements - -- PHP ^7.4.7 -- MongoDB -- Apache (optional) - -### Installation - -#### Prerequisites - -1. Install git and build-essentials for compiling PHP MongoDB library `sudo apt install git build-essential` -2. Install - 1. PHP: `sudo apt update && sudo apt -y install software-properties-common && sudo add-apt-repository ppa:ondrej/php && sudo apt-get update && sudo apt -y install php7.4` - 2. PHP dependencies `sudo apt install php7.4-{mbstring,xml,dev,pear,zip,common}` -3. Install PHP MongoDB driver `sudo pecl install mongodb` -4. Add `extension=mongodb.so` to your `php.ini` -5. Installing Apache (optional) - 1. `sudo apt install apache2` - 2. Set `AllowOverride All` in `apache2.conf` for `` - 3. Edit your virtual host document root - 1. By default in `/etc/apache2/sites-available/000-default.conf`: `DocumentRoot /var/www/jikan-rest/public` - - 4. Enable mod rewrite `sudo a2enmod deflate && sudo a2enmod rewrite` - 5. Enable mod deflate (for GZIP responses): `sudo a2enmod deflate && sudo a2enmod rewrite` - 4. Restart apache: `sudo service apache2 restart` - - -#### Jikan REST -1. Clone the repo in `/var/www` - `git clone https://github.com/jikan-me/jikan-rest.git` -2. Switch to v4 branch `git checkout v4` -3. Install [composer](https://getcomposer.org/download/) -4. Install project dependencies with composer `php path/to/composer.phar install` - -## Information +## Public REST API If you don't want to host your instance, there's a public API available. - **[REST DOCUMENTATION](http://docs.api.jikan.moe/)** -- **[Apps/Projects using JikanREST](https://jikan.moe/showcase)** +- **[Apps/Projects using JikanREST](https://jikan.moe/showcase)* + +## Documentation +Please view the [documentation](https://docs.api.jikan.moe/). +For any additional help, join our [Discord server](http://discord.jikan.moe/). ### Wrappers | Language | Wrappers | |------------|----------| | JavaScript | [JikanJS](https://github.com/zuritor/jikanjs) by Zuritor | -| Java | [Jikan4java](https://github.com/Doomsdayrs/Jikan4java) by Doomsdayrs
[reactive-jikan](https://github.com/SandroHc/reactive-jikan) by Sandro Marques | +| Java | [Jikan4java](https://github.com/Doomsdayrs/Jikan4java) by Doomsdayrs
[reactive-jikan](https://github.com/SandroHc/reactive-jikan) by Sandro Marques
[Jaikan](https://github.com/ShindouMihou/Jaikan) by ShindouMihou | | Python | [JikanPy](https://github.com/abhinavk99/jikanpy) by Abhinav Kasamsetty | | Node.js | [jikan-node](https://github.com/xy137/jikan-node) by xy137
[jikan-nodejs](https://github.com/ribeirogab/jikan-nodejs) by ribeirogab | | TypeScript | [jikants](https://github.com/Julien-Broyard/jikants) by Julien Broyard
[jikan-client](https://github.com/javi11/jikan-client) by Javier Blanco |