This repository has been archived on 2023-08-24. You can view files and clone it, but cannot push or open issues or pull requests.
bifm/docs/README.md
2022-07-23 04:02:03 -04:00

17 lines
740 B
Markdown

# Welcome
Welcome to BIFM's documentation. This is where you can find out how to get the best out of our project.
## General Use
- [**Supported Sites**](./general-docs/SITES.md) - Sites that are supported by BIFM.
- [**Public Instances**](./general-docs/INSTANCE.md) - All instances that the general public can access.
## Developer Use
How developers can use BIFM, either as an outsider os some
- [**API Usage**](./dev-docs/API.md) - How to tinker with BIFM to get information.
- [**Install BIFM**](./dev-docs/INSTALL.md) - How to install BIFM on your own server.
- [**Configure BIFM**](./dev-docs/CONFIG.md) - Configuring BIFM for use on your own instance.
- [**`tests.js`** usage](./dev-docs/TESTING.md) - Testing BIFM's extractors.