diff --git a/README.md b/README.md index 07c89a7..ebdfca7 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,35 @@ -Business App Template -===================== +TodayStream +=========== -This is an empty (but fully functional) PHP application. It is designed to -integrate with AccountHub, an account management web interface. AccountHub manages -user credentials and account data, and is accessed by this app via [a simple API](http://docs.netsyms.com/docs/AccountHub/API%20Documentation/). +TodayStream is a news/headlines reader and weather app. It is designed in a +modular fashion, to make adding data sources easy. -[Codacy badge](https://www.codacy.com/app/Netsyms/BusinessAppTemplate?utm_source=github.com&utm_medium=referral&utm_content=Netsyms/BusinessAppTemplate&utm_campaign=Badge_Grade) +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. -Program Structure ------------------ +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. -### Folders -* api - An API framework. See api/apisettings.php below. -* api/actions - A place to put your API actions. -* langs - Translations and alert messages. - The language files that are loaded depends on the value of `LANGUAGE` in `settings.php`. - All .json files in a language folder are parsed and loaded into the dictionary (use via `$Strings->get('some key')`). -* lib - A good place to put helper functions that you don't want "in the way". All files that end with `.lib.php` are automatically loaded. -* pages - What it looks like. If you go into `pages.php` and define a page with the name `foo`, there should be a `foo.php` in here. - The app checks before loading, so it will give a friendly 404 error if it doesn't find your page. - Woe to you if you delete `home.php` or `404.php`, as those are assumed to exist for fallback behavior. -* static - CSS, JavaScript, fonts, images... -* vendor - If you don't know what this is about, or you don't have it, you need to read up on Composer. Right now. +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`. -### Files -* settings.template.php - App configuration. Copy to `settings.php` and customize. Documented with inline comments. -* app.php - Handles the web part of the app. If you have problems with too many items on the navbar, change `$navbar_breakpoint`. - To change the navbar colors, find and edit `