Skip to content

horvathmarton/brief-me-api

Repository files navigation

Brief Me: News Summarizing Service

Brief Me is a powerful news summarizing service that ingests news from various sources and generates personalized digests tailored to your interests. Not only does it present content in a readable format, but it also offers an audio version, allowing you to catch up on the latest news simply by listening.

Table of Contents

Overview

In a fast-paced world where information is abundant, staying updated with the latest news can be overwhelming. Brief Me is designed to make your life easier by offering the following features:

Features

  • News Aggregation: Ingest news from various sources.
  • Personalized Digests: Receive news summaries tailored to your interests.
  • Readable Format: Content is presented in an easy-to-read manner.
  • Audio Version: Listen to news summaries on the go.

Getting Started

To get started with Brief Me, follow these steps:

  1. Clone the repository: git clone https://github.com/yourusername/brief-me.git
  2. Install the necessary dependencies: npm install
  3. Configure your API key and settings.
  4. Run the application: npm start

API Usage

To use Brief Me's API, you can make requests to the following endpoints:

  • /api/news: Get the latest news summaries.
  • /api/preferences: Set your news preferences.
  • /api/audio: Switch to audio mode.

For detailed API documentation, please refer to our API Documentation.

Audio Mode

Brief Me offers an audio mode, allowing you to catch up on news by listening. To enable audio mode, simply toggle the switch in the settings.

Contributing

We welcome contributions from the community! If you'd like to contribute to Brief Me, please read our Contribution Guidelines to get started.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

REST API to get personalized audio news digest.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published