mirror of
https://github.com/IT4Change/Ocelot-Social.git
synced 2025-12-13 07:45:56 +00:00
Improved readme
This commit is contained in:
parent
8e71c27b52
commit
053cc86888
39
README.md
39
README.md
@ -3,8 +3,45 @@ API Service for fetching URL Information like images, icons, descriptions etc. t
|
||||
|
||||
> early version of simpler embed api with Metascraper and oEmbed for better results.
|
||||
|
||||
## TODOS
|
||||
## Todo`s
|
||||
- [x] Metascraper
|
||||
- [x] oEmbed
|
||||
- [ ] API Cache
|
||||
- [ ] Image Caching
|
||||
|
||||
|
||||
## Install and start development server
|
||||
|
||||
Install dependencies
|
||||
```shell
|
||||
yarn install
|
||||
```
|
||||
|
||||
Start development server
|
||||
```shell
|
||||
yarn dev
|
||||
```
|
||||
|
||||
## Example Request
|
||||
Use the following request by posting it against the endpoint or open the url the `yarn dev` script did gave you and fire it there to get your first result.
|
||||
|
||||
```grapql
|
||||
{
|
||||
embed(url: "https://human-connection.org") {
|
||||
type
|
||||
embed
|
||||
title
|
||||
description
|
||||
author
|
||||
publisher
|
||||
url
|
||||
date
|
||||
image
|
||||
audio
|
||||
video
|
||||
lang
|
||||
logo
|
||||
sources
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user