Unverified Commit fe52c788 authored by Hong Minhee's avatar Hong Minhee
Browse files

Front matter for API reference

parent 4df7095c
Loading
Loading
Loading
Loading
+43 −1
Original line number Diff line number Diff line
/**
 * This module re-exports all the modules in the Fedify library.
 * Fedify: a fediverse server framework
 * ====================================
 *
 * Fedify is a [Deno]/TypeScript library for building federated server apps
 * powered by [ActivityPub] and other standards, which is so-called [fediverse].
 * You may already know some of the networks in the fediverse, such as
 * [Mastodon], [Lemmy], [Pixelfed], [PeerTube], and so on.  It aims to eliminate
 * the complexity and redundant boilerplate code when building a federated
 * server app, so that you can focus on your business logic and user experience.
 *
 * Fedify is still in the early stage of development, and it's not ready
 * for production use yet.  However, you can try it out and give feedback
 * to help improve it.
 * The rough roadmap is to implement the following features out of the box:
 *
 * - Type-safe objects for [Activity Vocabulary] (including some vendor-specific
 *   extensions)
 * - [WebFinger] client and server
 * - [HTTP Signatures]
 * - Middlewares for handling webhooks
 * - [ActivityPub] client
 * - [NodeInfo] protocol
 * - Special touch for interoperability with Mastodon and few other popular
 *   fediverse software
 *
 * If you want to know more about the project, please take a look at the
 * following resources:
 *
 * - [GitHub](https://github.com/dahlia/fedify)
 * - [Manual](./manual.md)
 * - [Examples](https://github.com/dahlia/fedify/tree/main/examples)
 *
 * [Deno]: https://deno.com/
 * [ActivityPub]: https://www.w3.org/TR/activitypub/
 * [fediverse]: https://en.wikipedia.org/wiki/Fediverse
 * [Mastodon]: https://joinmastodon.org/
 * [Lemmy]: https://join-lemmy.org/
 * [Pixelfed]: https://pixelfed.org/
 * [PeerTube]: https://joinpeertube.org/
 * [Activity Vocabulary]: https://www.w3.org/TR/activitystreams-vocabulary/
 * [WebFinger]: https://datatracker.ietf.org/doc/html/rfc7033
 * [HTTP Signatures]: https://tools.ietf.org/html/draft-cavage-http-signatures-12
 * [NodeInfo]: https://nodeinfo.diaspora.software/
 *
 * @module
 */