Skip to content

Latest commit

 

History

History
75 lines (59 loc) · 2.23 KB

README.md

File metadata and controls

75 lines (59 loc) · 2.23 KB

ReedBeeb Logo
A better client for BBC News.

ReadBeeb

GitHub releases License Tests

A better BBC News client for iOS.

This project is for educational and research purposes only.

Features

Top Stories Personal Feed Trending Videos Dark Mode

  • Dedicated videos tab
  • Supports all BBC News international services: English, Cymru, Arabic, Hindi, Mundo and Russian
  • Localised news results (English service only)
  • Support for low data mode
  • Dark mode
  • No analytics or tracking
  • No account or authentication required
  • Personalised news feed displayed in reverse-chronological order
  • Rewrite webpage articles to native in-app pages (beta)

Development

This repository contains the ReadBeeb-specific logic and GUI code. Logic related to the BBC News API should be contributed to bbc-news-swift.

Prerequisites:

To get started:

brew install swiftlint
git clone https://github.com/bilaalrashid/ReadBeeb.git
open ReadBeeb/ReadBeeb.xcodeproj

Full contributing guidelines can be found in CONTRIBUTING.md.

Tools

To update the list of installed topics:

make topics API_KEY=<BBC News OAuth2 Token>

Release

On the main branch:

  1. Bump the version and build number, and tag the project
make release # Defaults to patch
make release-<major|minor|patch>
make release-version VERSION=<version>
  1. Push to the remote
git push --follow-tags
  1. Create a corresponding release on GitHub