Staging for 0.5.0 release

TurkServer · May 12, 2017 · a083832 · a083832
1 parent 1a1a76b
commit a083832
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 30 deletions.
diff --git a/Contributing.md b/Contributing.md
@@ -0,0 +1,30 @@
+## Code
+
+Initial parts of this codebase were written in Coffeescript. However, any 
+updates and refactoring should be done in ES6, which implements many useful 
+functions from Coffeescript but allows more people to read the code and 
+contribute.
+Generally, follow AirBnb's [Javascript style guide](https://github.com/airbnb/javascript).
+
+More information to come.
+
+## Testing
+
+Clone this entire repository:
+
+```
+git clone https://github.com/TurkServer/turkserver-meteor.git turkserver
+```
+
+Then run the tests:
+
+```
+cd turkserver
+meteor test-packages ./
+```
+
+If you checked out the repository into an existing Meteor app, you can run `meteor test-packages turkserver` from your app instead.
+
+Browse to `http://localhost:3000` to run the tests.
+
+You don't have to run the tests yourself; this project is set up for continuous integration on [Travis CI](https://travis-ci.org/TurkServer/turkserver-meteor), which runs these tests on each commit. 
diff --git a/History.md b/History.md
@@ -0,0 +1,5 @@
+## vNEXT
+
+## v0.5.0
+
+- First release on Atmosphere (Meteor's package system).
diff --git a/README.md b/README.md
@@ -22,12 +22,6 @@ getting started, system architecture, experiment design, and examples.
 To add this to a Meteor app, follow these instructions: 
 
 1. [Install Meteor](http://docs.meteor.com/#quickstart) and create a Meteor app.
-2. In the app directory, install TurkServer locally (once we publish TurkServer to the Meteor packaging server, you will be able to omit this step):
-
-    ```
-    git clone https://github.com/TurkServer/turkserver-meteor.git packages/turkserver
-    ```
-
 3. `meteor add mizzao:turkserver` to install the package and its dependencies.
 4. Start your app with the `meteor` command.
 5. Navigate to `/turkserver` to log into the administration interface, and 
@@ -65,23 +59,6 @@ Note that this paper doesn't refer to the latest version of the system, but it
  is the same core idea. We plan to publish an improved paper detailing the 
  methods behind TurkServer in the near future. 
 
-## Testing
-
-Clone this entire repository:
-
-```
-git clone https://github.com/TurkServer/turkserver-meteor.git turkserver
-```
-
-Then run the tests:
-
-```
-cd turkserver
-meteor test-packages ./
-```
-
-If you checked out the repository into an existing Meteor app, you can run `meteor test-packages turkserver` from your app instead.
-
-Browse to `http://localhost:3000` to run the tests.
+## Developing and Contributing
 
-You don't have to run the tests yourself; this project is set up for continuous integration on [Travis CI](https://travis-ci.org/TurkServer/turkserver-meteor), which runs these tests on each commit. 
+See [more information about contributing](Contributing.md).
diff --git a/docs/client/forkme.html b/docs/client/forkme.html
@@ -1,5 +1,5 @@
 <body>
-<a href="https://github.com/HarvardEconCS/turkserver-meteor">
+<a href="https://github.com/TurkServer/turkserver-meteor">
     <img class="forkme" src="https://s3.amazonaws.com/github/ribbons/forkme_left_red_aa0000.png" alt="Fork me on GitHub">
 </a>
 </body>
diff --git a/package.js b/package.js
@@ -1,8 +1,8 @@
 Package.describe({
   name: "mizzao:turkserver",
-  summary: "Framework for building online, real-time user experiments in Meteor",
-  version: "0.0.0",
-  git: "https://github.com/HarvardEconCS/turkserver-meteor.git"
+  summary: "Web-based, real-time behavioral studies and experiments",
+  version: "0.5.0",
+  git: "https://github.com/TurkServer/turkserver-meteor.git"
 });
 
 Npm.depends({
@@ -154,9 +154,10 @@ Package.onTest(function (api) {
 
   api.use('iron:router'); // Needed so we can un-configure the router
   api.use('mizzao:partitioner');
-  api.use("mizzao:turkserver");
   api.use('mizzao:timesync');
 
+  api.use("mizzao:turkserver"); // This package!
+
   api.addFiles("tests/display_fix.css");
 
   api.addFiles('tests/utils.coffee'); // Deletes users so do it before insecure login