Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-shuman authored Aug 30, 2024
1 parent 26913ab commit 41b4f76
Showing 1 changed file with 32 additions and 3 deletions.
35 changes: 32 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ You can get a `JSON` list of articles by making a `GET` request to the `/article

`GET (http|https)://YOUR_URL/articles`

### Possible Responses

#### 200 -

## POST an article

You can add an article by providing the article's url in the body of a `POST` request:
Expand All @@ -26,11 +30,11 @@ You can add an article by providing the article's url in the body of a `POST` re
```json
{
// required
"url": "ARTICLE_URL",
"url": "https://dev.to/jacobshuman/wtf-is-a-github-profile-readmemd-1p8c",

// optional
"title": "WTF is a GitHub Profile README.md",
"description": "",
"description": "What is a profile README and why would I want one?",
"author": "Jacob Shuman",
"content": "",
"date": ""
Expand All @@ -47,6 +51,31 @@ Article was added to the SQLite database successfully.

The url was not found in the body of the request.

#### Unable to extract metadata at url (400)
#### 400 - Unable to extract metadata at url

There was an issue extracting the article metadata automatically. The article was **not** added to the SQLite database.

## Endpoints

### /rss (GET)
Content-Type - application/xml+rss

aliases
- /rss.xml
- /feed
- /feed.xml

#### Possible Responses

##### 200

##### 400

### /atom (GET

### /json (GET)

### /articles (GET)
Returns a JSON array of all articles in your reading list. Objects are FeedItems.

### /articles/add (POST)

0 comments on commit 41b4f76

Please sign in to comment.