D3r1ck01 has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/346787 )
Change subject: Adding License and Readme.md file ...................................................................... Adding License and Readme.md file * Licensing of the repo using and MIT license and also adding a README.md file for setting up the project on respective environments. Change-Id: I18a7e04a30620aa015b720bc828490950876ba48 --- A LICENSE A README.md 2 files changed, 96 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/labs/tools/Wikimedia-Emoji-Bot refs/changes/87/346787/1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e23dfda --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Alangi Derick + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..f8deb05 --- /dev/null +++ b/README.md @@ -0,0 +1,75 @@ +# Wikimedia Emoji Bot + +The source code for the Wikimedia Emoji Bot lives here + +## Configuration + +1. Clone project: + ```shell + git clone https://github.com/ch3nkula/Wikimedia-Emoji-Bot.git + ``` + +2. Install Need Package Manager/Management (NPM) on Mac OS X: + ```shell + brew install npm + ``` + + Will add 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. + +* When all these configs are done, your app can then connect to Twitter successfully and perform its various functions. + +## Usage + +### To post a status + +```shell +npm run status +``` + +### To reply to replies + +```shell +npm run reply +``` + +### Testing + +```shell +npm test +``` + +## 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 -- To view, visit https://gerrit.wikimedia.org/r/346787 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I18a7e04a30620aa015b720bc828490950876ba48 Gerrit-PatchSet: 1 Gerrit-Project: labs/tools/Wikimedia-Emoji-Bot Gerrit-Branch: master Gerrit-Owner: D3r1ck01 <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
