Add Readme.md

denim2x · Mar 8, 2019 · 11ad264 · 11ad264
1 parent 75cded7
commit 11ad264
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,17 @@
+# News intelligence engine
+
+Web app for browsing entities found within news articles
+
+## Setup
+
+First you should have certain variables in your environment:
+- `NEWSAPI_KEY`: API key for [News API](https://newsapi.org)
+- `DANDELION_TOKEN`: auth token for [Dandelion API](https://dandelion.eu/)
+- `GRAPHAPI_KEY`: API key for [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/)
+
+```sh
+npm install
+npm start
+```
+
+Launches a Web server at port `process.env.PORT` - open your browser to view the app in action.
diff --git a/public/index.html b/public/index.html
@@ -4,7 +4,7 @@
 <head>
   <meta charset="utf-8">
   <title>News intelligence engine</title>
-  <meta name="description" content="">
+  <meta name="description" content="Web app for browsing entities found within news articles">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <style>
     @import url('https://fonts.googleapis.com/css?family=Nunito');