Browse Source

chore(readme) setup readme file

Joe Richardson 1 year ago
parent
commit
4bdd516a65
4 changed files with 18 additions and 19 deletions
  1. 0
    6
      .env-sample
  2. 17
    0
      README.md
  3. 0
    12
      index.html
  4. 1
    1
      package.json

+ 0
- 6
.env-sample View File

@@ -1,6 +0,0 @@
1
-WEATHER_API_KEY=
2
-WEATHER_LOCATION=
3
-TWITTER_CONSUMER_KEY=
4
-TWITTER_CONSUMER_SECRET=
5
-TWITTER_ACCESS_TOKEN_KEY=
6
-TWITTER_ACCESS_TOKEN_SECRET=

+ 17
- 0
README.md View File

@@ -0,0 +1,17 @@
1
+### How to install
2
+
3
+1. `git clone git@github.com:dope/twitter-weather-bot`
4
+2. `npm install`
5
+3. Setup your `.env` file
6
+```bash
7
+WEATHER_API_KEY=
8
+WEATHER_LOCATION=
9
+TWITTER_CONSUMER_KEY=
10
+TWITTER_CONSUMER_SECRET=
11
+TWITTER_ACCESS_TOKEN_KEY=
12
+TWITTER_ACCESS_TOKEN_SECRET=
13
+```
14
+4. Run task `node index.js`
15
+
16
+### Setting up the cron job
17
+coming soon...

+ 0
- 12
index.html View File

@@ -1,12 +0,0 @@
1
-<!DOCTYPE html>
2
-<html lang="en" style="height: 100vh; background-color: #003090">
3
-<head>
4
-  <meta charset="UTF-8">
5
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
-  <meta http-equiv="X-UA-Compatible" content="ie=edge">
7
-  <title>Leicester Weather</title>
8
-</head>
9
-<body>
10
-
11
-</body>
12
-</html>

+ 1
- 1
package.json View File

@@ -1,5 +1,5 @@
1 1
 {
2
-  "name": "lcweather",
2
+  "name": "twitter-weather-bot",
3 3
   "version": "1.0.0",
4 4
   "description": "Twitter bot for weather",
5 5
   "main": "index.js",