You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

35 lines
1.2 KiB
Markdown

5 years ago
TodayStream
===========
7 years ago
5 years ago
TodayStream is a news/headlines reader and weather app. It is designed in a
modular fashion, to make adding data sources easy.
7 years ago
5 years ago
TodayStream ships with support for NewsAPI.org, Reddit, and DarkSky APIs.
With the exception of Reddit, you'll need to obtain and set API keys in
`settings.php` for TodayStream to be useful.
7 years ago
5 years ago
It currently determines the user's location for weather information based on IP
address. You'll need to download the (free) MaxMind city-level geoIP database
and keep it up-to-date. Other methods of obtaining location, such as with
JavaScript APIs and user-configurable settings, are coming soon.
7 years ago
5 years ago
This application does not and will not store user location on the server.
API responses are cached in the database for a reasonable amount of time, to
decrease latency and reduce (or eliminate) API costs. News item thumbnails are
resized and stored in `cache/thumb`.
7 years ago
6 years ago
Setup Tips
----------
* Run composer install (or composer.phar install) to install dependency libraries
5 years ago
* If you don't have any color in the navbar, run `git submodule init` and `git submodule update`.
-----
Required attribution: This product includes GeoLite2 data created by
MaxMind, available from http://www.maxmind.com