Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shahariaazam authored Aug 6, 2024
1 parent fde508d commit 3160e2b
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# headlines-go

A simple tool to fetch news headlines from different sources.

## Features

- REST Api endpoints. See the OpenAPI schema [here](https://github.com/shaharia-lab/headlines-go/blob/main/openapi.yaml).
- A basic UI to see the headlines

![image](https://github.com/user-attachments/assets/684d9744-cfed-4226-95c3-7becc5fa92e9)


## Contribution

It's very easy to add more news sources. Feel free to create a PR or. If you have any issues, please feel free to submit an issue [here](https://github.com/shaharia-lab/headlines-go/issues).

## License

Please see the license [here](https://github.com/shaharia-lab/headlines-go/blob/main/LICENSE).

0 comments on commit 3160e2b

Please sign in to comment.