Merge pull request #1 from gnosis/tweak-packaging

Tweak packaging

README.rst

@@ -1,28 +1,30 @@
-.. figure:: https://raw.githubusercontent.com/gnosis/pm-contracts/master/assets/logo.png
+.. figure:: https://raw.githubusercontent.com/gnosis/hg-contracts/development/assets/logo.png
    :target: https://gnosis.pm
    :alt: Gnosis Logo
 
 
-Gnosis Prediction Market Contracts
-==================================
+Gnosis Mercury
+==============
+Prediction Market Contracts
+---------------------------
 
-.. image:: https://travis-ci.org/gnosis/pm-contracts.svg?branch=development
-   :target: https://travis-ci.org/gnosis/pm-contracts
+.. image:: https://travis-ci.org/gnosis/hg-contracts.svg?branch=development
+   :target: https://travis-ci.org/gnosis/hg-contracts
    :alt: Build Status
 
-.. image:: https://badges.greenkeeper.io/gnosis/pm-contracts.svg
+.. image:: https://badges.greenkeeper.io/gnosis/hg-contracts.svg
    :target: https://greenkeeper.io/
    :alt: Greenkeeper badge
 
 .. image:: https://slack.gnosis.pm/badge.svg
    :target: https://slack.gnosis.pm
    :alt: Slack Status
 
-Collection of smart contracts for the `Gnosis`_ prediction market platform.
+Experimental smart contracts for prediction markets.
 
 `→ Online Documentation`_
 
-.. _→ Online Documentation: https://gnosis-pm-contracts.readthedocs.io/en/latest/
+.. _→ Online Documentation: https://gnosis-mercury.readthedocs.io/en/latest/
 .. _Gnosis: https://gnosis.pm
 
 

docs/changes-from-v1.rst

@@ -1,7 +1,7 @@
 Changes from Version 1.x
 ========================
 
-Documentation for the first version of the prediction market contract framework can be found `here <https://gnosis-pm-contracts.readthedocs.io/en/v1/>`_, or via the menu on the sidebar.
+Documentation for the first version of the prediction market contract framework can be found `here <https://gnosis-pm-contracts.readthedocs.io>`_, or via the menu on the sidebar.
 
 
 Modular vs Monolithic

docs/conf.py

@@ -19,7 +19,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Gnosis Prediction Market Contracts'
+project = 'Gnosis Mercury'
 copyright = '2018, Gnosis Ltd'
 author = 'Gnosis'
 
@@ -106,7 +106,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'GnosisPredictionMarketContractsdoc'
+htmlhelp_basename = 'GnosisMercurydoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -134,8 +134,8 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc,
-     'GnosisPredictionMarketContracts.tex',
-     'Gnosis Prediction Market Contracts Documentation',
+     'GnosisMercury.tex',
+     'Gnosis Mercury Documentation',
      'Gnosis', 'manual'),
 ]
 
@@ -145,8 +145,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'gnosispredictionmarketcontracts',
-     'Gnosis Prediction Market Contracts Documentation',
+    (master_doc, 'gnosismercury',
+     'Gnosis Mercury Documentation',
      [author], 1)
 ]
 
@@ -157,9 +157,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'GnosisPredictionMarketContracts',
-     'Gnosis Prediction Market Contracts Documentation',
-     author, 'GnosisPredictionMarketContracts',
+    (master_doc, 'GnosisMercury',
+     'Gnosis Mercury Documentation',
+     author, 'GnosisMercury',
      'One line description of project.',
      'Miscellaneous'),
 ]

docs/contributing.rst

@@ -3,7 +3,7 @@ Contributing
 
 The source for the contracts can be found on `Github`_.
 
-.. _Github: https://github.com/gnosis/pm-contracts
+.. _Github: https://github.com/gnosis/hg-contracts
 
 .. highlight:: bash
 

docs/developer-guide.rst

@@ -3,9 +3,7 @@ Developer Guide
 
 .. warning::
 
-    This document refers to a version of the framework which is under development. Some things may change. You may also be interested in `v1`_ of this framework.
-
-.. _v1: https://gnosis-pm-contracts.readthedocs.io/en/v1/
+    This document refers to an experimental prediction market framework under active development. Some things may change. You may also be interested in the predecessor of this work: the original `Gnosis prediction market contracts <https://gnosis-pm-contracts.readthedocs.io>`_.
 
 Prerequisites
 -------------
@@ -20,7 +18,7 @@ The current state of this smart contract system may be found on `Github`_.
 .. _Truffle: https://truffleframework.com
 .. _web3.js: https://web3js.readthedocs.io/en/1.0/
 .. _TruffleContract: https://github.com/trufflesuite/truffle/tree/next/packages/truffle-contract#truffle-contract
-.. _Github: https://github.com/gnosis/pm-contracts
+.. _Github: https://github.com/gnosis/hg-contracts
 
 Installation
 ------------
@@ -30,7 +28,7 @@ Via NPM
 
 This developmental framework may be installed from Github through NPM by running the following::
 
-    npm i gnosis/pm-contracts
+    npm i '@gnosis.pm/hg-contracts'
 
 
 Preparing a Condition

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gnosis.pm/hg-contracts",
-  "version": "2.0.0-alpha.3",
+  "version": "0.1.0",
   "description": "Collection of smart contracts for the Gnosis prediction market platform",
   "scripts": {
     "setup-githooks": "git config core.hooksPath .githooks",