diff --git a/build/actions/os.js b/build/actions/os.js index c1ca26ff..7c655be8 100644 --- a/build/actions/os.js +++ b/build/actions/os.js @@ -26,7 +26,7 @@ exports.download = { signature: 'os download ', description: 'download device OS', - help: 'Use this command to download the device OS configured to a specific network.\n\nEthernet:\n You can setup the device OS to use ethernet by setting the `--network` option to "ethernet".\n\nWifi:\n You can setup the device OS to use wifi by setting the `--network` option to "wifi".\n If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.\n\nBy default, this command saved the downloaded image into a resin specific directory.\nYou can save it to a custom location by specifying the `--output` option.\n\nExamples:\n\n $ resin os download 91 --network ethernet\n $ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123\n $ resin os download 91 --network ethernet --output ~/MyResinOS.zip', + help: 'Use this command to download the device OS configured to a specific network.\n\nEthernet:\n You can setup the device OS to use ethernet by setting the `--network` option to "ethernet".\n\nWifi:\n You can setup the device OS to use wifi by setting the `--network` option to "wifi".\n If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.\n\nAlternatively, you can omit all kind of network configuration options to configure interactively.\n\nYou have to specify an output location with the `--output` option.\n\nExamples:\n\n $ resin os download 91 --output ~/MyResinOS.zip\n $ resin os download 91 --network ethernet --output ~/MyResinOS.zip\n $ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123 --output ~/MyResinOS.zip\n $ resin os download 91 --network ethernet --output ~/MyResinOS.zip', options: [ commandOptions.network, commandOptions.wifiSsid, commandOptions.wifiKey, { signature: 'output', diff --git a/doc/app/associate.md b/doc/app/associate.md new file mode 100644 index 00000000..f62aa210 --- /dev/null +++ b/doc/app/associate.md @@ -0,0 +1,10 @@ +# app associate + +Use this command to associate a project directory with a resin application. + +This command adds a 'resin' git remote to the directory and runs git init if necessary. + +Examples: + + $ resin app associate 91 + $ resin app associate 91 --project my/app/directory diff --git a/doc/app/init.md b/doc/app/init.md index 47ed51f8..db66b5b3 100644 --- a/doc/app/init.md +++ b/doc/app/init.md @@ -1,10 +1,13 @@ -# init +# init -Use this command to associate a local project to an existing resin.io application. +Use this command to initialise a directory as a resin application. -The application should be a git repository before issuing this command. -Notice this command adds a `resin` git remote to your application. +This command performs the following steps: + - Create a resin.io application. + - Initialize the current directory as a git repository. + - Add the corresponding git remote to the application. Examples: - $ cd myApp && resin init 91 + $ resin init + $ resin init --project my/app/directory diff --git a/doc/os/download.md b/doc/os/download.md index cc4c3ff6..23b97e16 100644 --- a/doc/os/download.md +++ b/doc/os/download.md @@ -9,13 +9,15 @@ Wifi: You can setup the device OS to use wifi by setting the `--network` option to "wifi". If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well. -By default, this command saved the downloaded image into a resin specific directory. -You can save it to a custom location by specifying the `--output` option. +Alternatively, you can omit all kind of network configuration options to configure interactively. + +You have to specify an output location with the `--output` option. Examples: - $ resin os download 91 --network ethernet - $ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123 + $ resin os download 91 --output ~/MyResinOS.zip + $ resin os download 91 --network ethernet --output ~/MyResinOS.zip + $ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123 --output ~/MyResinOS.zip $ resin os download 91 --network ethernet --output ~/MyResinOS.zip ## Options diff --git a/lib/actions/os.coffee b/lib/actions/os.coffee index 9f634e47..6c94a0bf 100644 --- a/lib/actions/os.coffee +++ b/lib/actions/os.coffee @@ -23,13 +23,15 @@ exports.download = You can setup the device OS to use wifi by setting the `--network` option to "wifi". If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well. - By default, this command saved the downloaded image into a resin specific directory. - You can save it to a custom location by specifying the `--output` option. + Alternatively, you can omit all kind of network configuration options to configure interactively. + + You have to specify an output location with the `--output` option. Examples: - $ resin os download 91 --network ethernet - $ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123 + $ resin os download 91 --output ~/MyResinOS.zip + $ resin os download 91 --network ethernet --output ~/MyResinOS.zip + $ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123 --output ~/MyResinOS.zip $ resin os download 91 --network ethernet --output ~/MyResinOS.zip ''' options: [