Commit Graph

48 Commits

Author SHA1 Message Date
Tim Perry
cfdd4d3d69 Update README to link to the full CLI command documentation
Also update description to match package.json & repo, and remove
quickstart (since it's unstable at the moment).

Change-Type: patch
2017-08-31 19:37:19 +08:00
Eugene Mirotin
24388811ad remove the user requirement for the supported devices list 2017-06-15 16:38:55 +03:00
Eugene Mirotin
880fb43fd9 some fixes 2017-05-18 15:12:52 +03:00
Eugene Mirotin
bc79832e1d resin ssh proxy support 2017-05-12 18:09:43 +03:00
Eugene Mirotin
380a94f0f8 update to modules that have native node v4 support 2017-04-14 14:48:19 +03:00
alisondavis17
8474ee726c Update README.md
Change Support section to point to Forums instead of Gitter
2017-03-09 14:46:20 -08:00
Kostas Lekkas
bbd617ea76 docs: rename 'Git Bash' to 'Git for Windows' 2017-01-18 19:33:49 +02:00
Kostas Lekkas
d473509675 Docs: fix requirements for resin ssh and resin sync
change-type: patch
2017-01-18 18:04:37 +02:00
Juan Cruz Viotti
1b7aeeafc1 Link to resin-plugin-hello from README 2016-03-31 10:11:05 -04:00
Gergely Imreh
d578f62dca escape gitter image link
This is to fix bage link on npmjs.org, hopefully, as currently
it seems it cannot handle real spaces in image URLs.
2016-02-13 09:27:42 +08:00
Gergely Imreh
d4527220c3 fix dependencies badge link 2016-02-13 09:21:08 +08:00
Juan Cruz Viotti
654c3c627d Move Invalid MBR error explanation to TROUBLESHOOTING 2016-02-12 14:45:00 -04:00
Juan Cruz Viotti
a8c30bb395 Document corruped image MBR error 2016-01-22 10:14:55 -04:00
Juan Cruz Viotti
5f83c870ed Improve README header style
- Use SVG badges.
- Set description as a blockquote before the title.
2016-01-21 23:17:02 -04:00
Juan Cruz Viotti
bca9a7f51f Remove build status CI badges from README
CI integration was removed in
96f0b5fbd6,
but it looks like we forgot to remove the badges.
2016-01-21 10:42:45 -04:00
Juan Cruz Viotti
612437ae58 Improvee FAQ with more frequent questions 2016-01-13 00:20:18 -04:00
Juan Cruz Viotti
35a821b904 Improve FAQ staging resin url title 2016-01-13 00:13:07 -04:00
Juan Cruz Viotti
e4359834d6 Rename README documentation section to FAQ 2016-01-13 00:12:04 -04:00
Juan Cruz Viotti
9b052c9aa5 Handle authentication in quickstart
If the user is not logged in, make quickstart prompt for authentication
automatically.
2016-01-12 10:12:44 -04:00
Juan Cruz Viotti
301b8a6ba3 Merge pull request #290 from resin-io/doc/quickstart-sudo
Stop instructing users to run quickstart as root
2016-01-12 08:08:34 -04:00
Juan Cruz Viotti
a90d578c85 Point users to Gitter in Support README section 2016-01-11 16:04:22 -04:00
Juan Cruz Viotti
d859228aa9 Stop instructing users to run quickstart as root
Elevation is asked in specific steps automatically.
2016-01-11 16:01:40 -04:00
Juan Cruz Viotti
351dfdb892 Merge pull request #287 from resin-io/feat/gitter-badge
Add Gitter badge
2016-01-11 12:19:06 -04:00
Juan Cruz Viotti
dc6727fbf1 Add Gitter badge 2016-01-11 11:28:33 -04:00
Juan Cruz Viotti
9cfce68489 Change license to Apache 2.0 2016-01-03 23:58:51 -04:00
Juan Cruz Viotti
0ad4598575 Document how to point the CLI to staging 2015-12-31 22:00:39 -04:00
Juan Cruz Viotti
b668a8c7d0 Add --production to installation instructions 2015-12-04 08:31:39 -04:00
Juan Cruz Viotti
d8a2b82662 Move Cygwin caveat from README to TROUBLESHOOTING 2015-09-21 08:51:54 -04:00
Juan Cruz Viotti
b0be5de83a Add Troubleshooting guide
This guide described common Resin CLI issues and how to fix them.
2015-09-21 08:32:11 -04:00
Juan Cruz Viotti
eecd7a0fd8 Improve README.md
- Make user oriented instead of developer oriented.
- Remove deprecated information.
- Add Requisites section.
- Add Getting Started section.
- Add Support section.
- Add License section.
2015-09-21 07:56:24 -04:00
Juan Cruz Viotti
1c48328347 Remove Man pages section from README.md
Man pages are not longer being produced.
2015-08-20 12:04:11 -04:00
Juan Cruz Viotti
72d4b21cb4 Configure appveyor CI 2015-05-21 10:52:37 -04:00
Juan Cruz Viotti
a1e6c6cda5 Stop bundling NodeJS in the package 2015-03-04 12:16:35 -04:00
Juan Cruz Viotti
14523f033d Clean README 2015-03-03 15:05:46 -04:00
Juan Cruz Viotti
3726107f20 Add NPM badge 2015-03-03 14:32:13 -04:00
Juan Cruz Viotti
eef26eb67f Remove private Google Doc link from README 2015-03-02 12:40:50 -04:00
Juan Cruz Viotti
3b95fefeb0 Add dependencies and Travis CI badges 2015-03-02 12:34:15 -04:00
Juan Cruz Viotti
9d4eb545db Update run direct instruction to build/ 2015-03-02 12:30:07 -04:00
Juan Cruz Viotti
57b23caed6 Update git clone url to github 2015-03-02 12:26:38 -04:00
Juan Cruz Viotti
83e01c03fa Remove obsolete Command README caveat 2015-03-02 10:45:18 -04:00
Juan Cruz Viotti
7b5a5e8f77 Explain how to produce a binary in README.md 2014-12-30 13:20:07 -04:00
Juan Cruz Viotti
3304e4bc98 Fix global *.roff installation issue
NPM refuses to install man pages that end in *.roff.
2014-12-24 15:12:31 -04:00
Juan Cruz Viotti
7246740336 Add information about why CLI doesn't work fine on Cygwin 2014-12-24 08:04:36 -04:00
Juan Cruz Viotti
e4780b12f6 Implement basic man page 2014-12-10 15:18:39 -04:00
Juan Cruz Viotti
3717831c38 Implement errors.handle() debug support 2014-12-10 14:13:42 -04:00
Juan Cruz Viotti
06f6b47fd1 Show help if no command is passed 2014-12-10 13:44:56 -04:00
Juan Cruz Viotti
3a5e4ad074 Remove JS compilation step for running bin/resin 2014-12-09 15:40:38 -04:00
Juan Cruz Viotti
e82173bfb5 Write README.md 2014-12-09 15:23:17 -04:00