-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation #14
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Closing this as the only thing that really should be done is to modify the package.json and Travis config and republish it, deprecating the old package on NPM
@@ -2,7 +2,7 @@ | |||
|
|||
This is a collection of contracts related to specifically to Gnosis Olympia. These contracts can be used in setting up prediction market tournaments. | |||
|
|||
This is the Olympia token contract implementation: | |||
This is the pm-apollo-token contract implementation: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The repo may be changed, but the name of the token contract should still by OlympiaToken iirc. Also, I think these addresses refer specifically to Olympia stuff, so this can remain the same.
@@ -22,7 +22,7 @@ The ability to issue new tokens to addresses, or minting tokens, is restricted t | |||
|
|||
The creator of the contract instance is also required to specify accounts which will be administrators of this contract. The creator and these administrators are, in turn, required to specify a whitelist for token transfers. This prevents arbitrary transfers of token value from one account to another. PlayTokens can be transferred only to or from the whitelisted addresses. You may use this mechanic to ensure that users can only perform transactions with the token on authorized contracts in an event. | |||
|
|||
## OlympiaToken |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same re: OlympiaToken contract name
@@ -92,4 +92,4 @@ The `--from <account>` specifies an account with which to do the transaction. | |||
|
|||
If you have deployments on multiple networks, you can specify the network you mean the script to interact with via the `--network <network name>` option. | |||
|
|||
Finally, if you have happened to rename the PlayToken from OlympiaToken to something else, you can specify that name via the `--play-token-name <new case-sensitive name>` option. | |||
Finally, if you have happened to rename the PlayToken from pm-apollo-token to something else, you can specify that name via the `--play-token-name <new case-sensitive name>` option. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here
Documentation updated to be consistent with the new project names.
After renaming the repo, package.json and .travis.yml need to be updated ;)