This is an extension library that only has a peer dependency to piral-core
. What piral-feeds
brings to the table is a set of API extensions that can be used with piral
or piral-core
. By default, these extensions are not integrated in piral
, so you'd need to add them to your Piral instance.
Documentation
For details on the provided API check out the documentation at the Piral website or on GitHub.
Setup and Bootstrapping
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import createFeedsApi
from the piral-feeds
package.
import { createFeedsApi } from 'piral-feeds';
The integration looks like:
const instance = createInstance({
extendApi: [createFeedsApi()],
});
There are no options available.
License
Piral is released using the MIT license. For more information see the license file.