jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/348010 )

Change subject: Add configs, docs and credit contributors
......................................................................


Add configs, docs and credit contributors

* Updated README.md with information on how to setup the project
  locally for developers.

* Gave credits for the original authors of the NYPL bot his team.

* Various commands on how to test and how to contribute to the repo
  is also included in the README.md file.

* Added a .env.example file for Twitter API config credentials in the
  .env file.

* .gitignore file to ignore some files not to be pushed to the repo
  online.

* Added a CREDITS file with curated list of names and emails of everyone
  that has contributed to the repository interms of mentoring, coding or
  documentation.

Change-Id: I70b49569ddfc0cf151598cce245340a5acb5650f
---
A .env.example
A .gitignore
A CREDITS
M README.md
M package.json
5 files changed, 77 insertions(+), 20 deletions(-)

Approvals:
  D3r1ck01: Verified; Looks good to me, approved
  jenkins-bot: Verified
  Dereckson: Looks good to me, but someone else must approve



diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..7c51373
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,5 @@
+TWITTER_CONSUMER_KEY=
+TWITTER_CONSUMER_SECRET=
+TWITTER_ACCESS_TOKEN=
+TWITTER_ACCESS_TOKEN_SECRET=
+TWITTER_SCREEN_NAME=
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..3bb2a67
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,4 @@
+node_modules/*
+npm-debug.log
+
+.env
diff --git a/CREDITS b/CREDITS
new file mode 100644
index 0000000..555d8f3
--- /dev/null
+++ b/CREDITS
@@ -0,0 +1,11 @@
+= Credits =
+
+== Project mentors ==
+* Ariel Glenn <ar...@wikimedia.org>
+* S├ębastien Santoro <dereck...@espace-win.org>
+* Yuri Astrakhan <yuriastrak...@gmail.com>
+
+== Author(s) ==
+* Alangi Derick <alangider...@gmail.com>
+
+== Contributors (alphabetically) ==
\ No newline at end of file
diff --git a/README.md b/README.md
index 0afd4b9..f97bacb 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,57 @@
-# Wikimedia Emoji Bot
\ No newline at end of file
+# Wikimedia Emoji Bot
+
+The source code for the Wikimedia Emoji Bot lives here
+
+## Configuration
+
+1. Clone project:
+  ```shell
+  $ git clone https://github.com/wikimedia/labs-tools-Wikimedia-Emoji-Bot
+  ```
+
+2. Install Package Manager/Management (NPM) on Mac OS X:
+  ```shell
+  $ brew install npm
+  ```
+
+  Will add `npm` installation commands for other systems later here.
+
+3. Install dependencies for the project:
+
+  ```shell
+  $ npm install
+  ```
+
+4. Copy the example `.env` file:
+
+  ```shell
+  $ cp .env.example .env
+  ```
+
+5. [Get credentials for your bot](https://dev.twitter.com/) and complete the 
`.env`
+
+* When logged-in on the Twitter's developer site, check the link on the top 
menu `My apps` (and it will take you to this site: https://apps.twitter.com/) 
or go straight away to type: https://apps.twitter.com/ on your browser.
+
+* On the top-right, there is a button saying `Create New App`, click on it and 
follow the steps to fill in the form fields.
+
+* Click the `Create your Twitter Application` button when you finish the 
immediate above step.
+
+* Once the application is created, under the `Details` section, you will find 
the credentials to fill into your `.env` file and additionally, under the `Keys 
and Access tokens`, you will find all the keys and access tokens needed in the 
`.env` file.
+
+* After putting config variables in the .env file, your app can then connect 
to use the Twitter API successfully.
+
+* Functionalities of the application will be put up here soon as development 
continues.
+
+## Contributing
+
+Emoji additions, bug reports, fixes, and new features are welcomed. If you'd 
like to contribute code, please:
+
+1. Fork the project
+
+2. Start a branch named for your new feature or bug
+
+3. Create a Pull Request
+
+## Forked / Built on
+
+This project is originally built on the [NYPL Emoji Bot 
project](https://github.com/lolibrarian/NYPL-Emoji-Bot). Initial credits go to: 
Lauren Lampasone and other contributors for building the NYPL-Emoji-Bot.
\ No newline at end of file
diff --git a/package.json b/package.json
index cbbb132..ee2f700 100644
--- a/package.json
+++ b/package.json
@@ -2,25 +2,6 @@
     "name": "wikimedia-emoji-bot",
     "version": "1.0.0",
     "description": "A Wikimedia Twitter bot that receives emojis and return 
images on commons matching properties of the emoji.",
-    "author": {
-        "name": "Alangi Derick",
-        "email": "alangider...@gmail.com",
-        "url": "https://github.com/ch3nkula";
-    },
-    "contributors": [
-        {
-            "name": "S├ębastien Santoro",
-            "email": "dereck...@espace-win.org"
-        },
-        {
-            "name": "Ariel Glenn",
-            "email": "ar...@wikimedia.org"
-        },
-        {
-            "name": "Yuri Astrakhan",
-            "email": "yuriastrak...@gmail.com"
-        }
-    ],
     "main": "src/status.js",
     "scripts": {
     },

-- 
To view, visit https://gerrit.wikimedia.org/r/348010
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I70b49569ddfc0cf151598cce245340a5acb5650f
Gerrit-PatchSet: 5
Gerrit-Project: labs/tools/Wikimedia-Emoji-Bot
Gerrit-Branch: master
Gerrit-Owner: D3r1ck01 <alangider...@gmail.com>
Gerrit-Reviewer: ArielGlenn <ar...@wikimedia.org>
Gerrit-Reviewer: D3r1ck01 <alangider...@gmail.com>
Gerrit-Reviewer: Dereckson <dereck...@espace-win.org>
Gerrit-Reviewer: Yurik <yuriastrak...@gmail.com>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to