From e9c566393e59c0281bb388ca13e78abef473d7f6 Mon Sep 17 00:00:00 2001 From: Oliver Nordbjerg Date: Wed, 15 Nov 2017 10:56:18 +0100 Subject: [PATCH 1/2] Rename module to application Closes #19 --- README.md | 22 +++++++++++----------- bin/cli.js | 12 ++++++------ src/handle.js | 8 ++++---- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 671cc0182..f2f475ca4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Aragon CLI -CLI tool for creating, testing and publishing Aragon modules. +CLI tool for creating, testing and publishing Aragon applications. ## Installation @@ -11,7 +11,7 @@ npm install -g @aragon/cli ## Usage ``` -➜ aragon-example-module aragon-dev-cli --help +➜ aragon-example-application aragon-dev-cli --help Aragon command-line tools @@ -19,11 +19,11 @@ npm install -g @aragon/cli $ aragon-dev-cli Commands - init Initialize a new Aragon module - version Bump the module version - versions List the published versions of this module - publish Publish a new version of the module - playground Inject module into local Aragon application + init Initialize a new Aragon application + version Bump the application version + versions List the published versions of this application + publish Publish a new version of the application + playground Inject application into local Aragon application Options --key The Ethereum private key to sign transactions with. Raw transaction will be dumped to stdout if no key is provided. @@ -35,16 +35,16 @@ npm install -g @aragon/cli $ aragon-dev-cli version major New version is 2.0.0 - $ aragon-dev-cli init poll --registry=module-corp.eth - Created new module poll.module-corp.eth + $ aragon-dev-cli init poll --registry=application-corp.eth + Created new application poll.application-corp.eth $ aragon-dev-cli init cool-app - Created new module cool-app.aragonpm.eth + Created new application cool-app.aragonpm.eth ``` ## Recipes -### Creating and publishing a module +### Creating and publishing an application ```bash mkdir polls-app diff --git a/bin/cli.js b/bin/cli.js index 39b1b476d..b0e8ec1f2 100755 --- a/bin/cli.js +++ b/bin/cli.js @@ -7,11 +7,11 @@ const cli = meow(` $ aragon-dev-cli Commands - init Initialize a new Aragon module (e.g. test.aragonpm.eth) - version Bump the module version - versions List the published versions of this module - publish Publish a new version of the module - playground Inject module into local Aragon application + init Initialize a new Aragon application (e.g. test.aragonpm.eth) + version Bump the application version + versions List the published versions of this application + publish Publish a new version of the application + playground Inject application into local Aragon instance Options --key The Ethereum private key to sign transactions with. Raw transaction will be dumped to stdout if no key is provided. @@ -24,7 +24,7 @@ const cli = meow(` New version is 2.0.0 $ aragon-dev-cli init cool-app.aragonpm.eth - Created new module cool-app.aragonpm.eth + Created new application cool-app.aragonpm.eth `, { default: { rpc: 'https://ropsten.infura.io', diff --git a/src/handle.js b/src/handle.js index 384d98da1..ecc42ea9d 100644 --- a/src/handle.js +++ b/src/handle.js @@ -32,7 +32,7 @@ const handlers = { roles: [], path: 'src/App.sol' }).then(({ appName }) => { - reporter.info(`Created new module ${appName}`) + reporter.info(`Created new application ${appName}`) }) }, versions (_, flags) { @@ -185,7 +185,7 @@ const handlers = { )).pop().hash // Next! - reporter.info(`Published module to IPFS: ${hash}`) + reporter.info(`Published application to IPFS: ${hash}`) resolve(hash) }) }) @@ -208,7 +208,7 @@ const handlers = { return } - reporter.info('This is the first time you are publishing this module') + reporter.info('This is the first time you are publishing this application') const registry = new eth.Contract( require('../abi/apm/RepoRegistry.json'), registryAddress @@ -241,7 +241,7 @@ const handlers = { .then((tx) => { return eth.sendSignedTransaction(tx.rawTransaction) .then(({ transactionHash }) => { - reporter.info(`Created module ${appName}@${version} in transaction ${transactionHash}`) + reporter.info(`Created application ${appName}@${version} in transaction ${transactionHash}`) }, (err) => { reporter.error(err) }) From 7be532d2eb5f9a25b2cba439a173660cb0391235 Mon Sep 17 00:00:00 2001 From: Oliver Nordbjerg Date: Wed, 15 Nov 2017 12:24:11 +0100 Subject: [PATCH 2/2] Use better wording in usage --- README.md | 13 ++++--------- bin/cli.js | 2 +- 2 files changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f2f475ca4..73f386b2e 100644 --- a/README.md +++ b/README.md @@ -13,32 +13,27 @@ npm install -g @aragon/cli ``` ➜ aragon-example-application aragon-dev-cli --help - Aragon command-line tools - Usage $ aragon-dev-cli Commands - init Initialize a new Aragon application + init Initialize a new Aragon application (e.g. test.aragonpm.eth) version Bump the application version versions List the published versions of this application publish Publish a new version of the application - playground Inject application into local Aragon application + playground Inject application into local Aragon client Options --key The Ethereum private key to sign transactions with. Raw transaction will be dumped to stdout if no key is provided. - --registry The repository registry to use for creating and publishing packages (default: aragonpm.eth) --rpc A URI to the Ethereum node used for RPC calls (default: https://ropsten.infura.io) --chain-id The ID of the chain to interact with (default: 3) + --ens-registry Address for the ENS registry (default: canonical ENS for chainId) Examples $ aragon-dev-cli version major New version is 2.0.0 - $ aragon-dev-cli init poll --registry=application-corp.eth - Created new application poll.application-corp.eth - - $ aragon-dev-cli init cool-app + $ aragon-dev-cli init cool-app.aragonpm.eth Created new application cool-app.aragonpm.eth ``` diff --git a/bin/cli.js b/bin/cli.js index b0e8ec1f2..9cfe8aad8 100755 --- a/bin/cli.js +++ b/bin/cli.js @@ -11,7 +11,7 @@ const cli = meow(` version Bump the application version versions List the published versions of this application publish Publish a new version of the application - playground Inject application into local Aragon instance + playground Inject application into local Aragon client Options --key The Ethereum private key to sign transactions with. Raw transaction will be dumped to stdout if no key is provided.