Commit Graph

247 Commits

Author SHA1 Message Date
Vincent Tunru
b6f160a7b3 Fixes #995: Add example .nvmrc to the README 2016-03-27 00:15:31 +01:00
Frankie Bagnardi
d03f575446 Adds fast-nvm-fish to README 2016-03-17 14:14:21 -07:00
flowmemo
d8a3b074a6 fixed the number of alternatives in Windows in README.markdown 2016-03-11 23:31:28 +08:00
Whitney Young
972be30a1a Add link to avn
Also, clarified the existing shell integration intro text.
2016-03-08 19:48:27 -08:00
Tobias Witt
ae70d558cb
Add section about "Deeper shell integration"
Also adds a snippet for zsh user to auto-issue `nvm use` when entering a
directory.
2016-03-08 18:44:30 +01:00
Adam Patridge
e76221fd15 Added note about OSX's missing .bash_profile file. 2016-03-03 14:01:23 -07:00
Jordan Harband
2176894a5b v0.31.0 2016-02-15 09:18:15 -08:00
gmisra
8a20234586 Document how to reload nvm after upgrading 2016-02-09 19:12:22 -08:00
Jordan Harband
21c3727955 v0.30.2 2016-01-21 00:23:01 -08:00
Dwayne Crooks
1e1a005a53 [Docs] Add manual upgrade instructions to README.markdown 2016-01-16 07:01:46 -04:00
Jordan Harband
0aa3118de3 v0.30.1 2015-12-28 12:46:41 -08:00
Jordan Harband
8ec056f768 v0.30.0 2015-12-27 23:19:14 -08:00
thelostspore
1a6f85da46 README: troubleshooting scenario and homebrew unsupported note 2015-12-27 12:55:35 -08:00
Tom Byrer
2a8caf48e8 del nvmw link
Seems to be abandoned:
- https://github.com/hakobera/nvmw/issues/67
- https://github.com/hakobera/nvmw/issues/66
- https://github.com/hakobera/nvmw/issues/69
2015-12-13 18:16:14 -07:00
Daniel Kmak
896199facc Update README.markdown and LICENSE.md 2015-12-12 20:00:49 +01:00
Riyadh Al Nur
dbe2a1b2b4 Updated README
Updated README to inform OSX users that XCode doesn't need to be installed in order to get stsrted using `nvm`.

Fixes #921
2015-12-05 13:52:30 +06:00
Jordan Harband
317f8f9e68 Merge pull request #901 from PeterDaveHello/patch-4
[Docs] add FreeBSD info to README
2015-12-04 23:42:51 -08:00
Peter Dave Hello
4ef9e1583c Update README.markdown
Talk about FreeBSD support.
Hope user can easily know that earlier, and also hope we can get much more help about this topic.
2015-12-05 15:41:04 +08:00
Jordan Harband
09bf45ce6c Merge pull request #908 from nullivex/master
[Docs] Add another Windows alternative.
2015-12-04 23:35:30 -08:00
Jordan Harband
6d2c9a95b0 [Docs] remove note about "global install", since nvm is not intended for multiuser installs.
Per https://github.com/creationix/nvm/issues/918#issuecomment-161527422
2015-12-02 22:14:08 -08:00
Bryan Tong
720087b009 Add another Windows alternative.
Nodist is a similar CLI interface providing similar functionality. Nodist also recently added a Windows install wizard.
2015-11-18 20:18:55 -07:00
Jordan Harband
e10705b896 [Docs] improve manual install instructions 2015-11-09 11:36:30 -08:00
Jordan Harband
9972de6dec [Docs] update version numbers in the readme; add default alias info 2015-11-04 21:19:32 -08:00
Whitney Young
9cceded178 Updated docs for alias default. 2015-11-03 10:44:07 -08:00
Derek Willian Stavis
84c2d6a91f README: Add link to a dedicated nvm wrapper for fish shell
Includes references to `nvm` plugin for Oh My Fish framework,
which implements not only a fish wrapper to official `nvm` script,
but also provides completions.
2015-10-15 21:00:23 -03:00
John Firebaugh
affe0baa95 Note compatibility issue with set -e
See discussion in #865.
2015-10-09 11:01:07 -07:00
Jordan Harband
e1c84bae37 v0.29.0 2015-10-09 01:52:19 -07:00
fresheneesz
49f2c95013 Install OR update 2015-10-05 15:56:41 -07:00
Jordan Harband
ebdcdc4363 v0.28.0 2015-10-02 01:50:44 -07:00
Jordan Harband
8aebf86329 v0.27.1 2015-09-27 06:40:29 -07:00
Jordan Harband
838d72688f v0.27.0 2015-09-26 10:13:10 -07:00
Jordan Harband
26ee4aafc0 v0.26.1 2015-08-22 20:54:31 -07:00
Jordan Harband
49abc9ce02 v0.26.0 2015-08-13 17:10:08 -07:00
Alexey Komarov
543b86c060 Replace links to nvm-fish and nvm-fish-wrapper with a link to bass 2015-08-13 09:09:51 +03:00
Haralan Dobrev
31e7d5b36a Use neither in README
Correct usage of the [neither-nor](https://en.wiktionary.org/wiki/neither) construction.
2015-08-10 20:34:10 +03:00
Rey Bango
d9662f138f Updated based on feedback from @ljharb on syntax description and functionality 2015-08-04 17:35:03 -04:00
Rey Bango
b7a93be02e Updated to added npm to the text 2015-08-04 15:23:07 -04:00
Rey Bango
3543cd5d2f Updated usage instructions to include --reinstall-packages-from syntax and example 2015-08-04 15:19:38 -04:00
Jordan Harband
d78722b284 v0.25.4 2015-05-29 11:11:40 -07:00
Peter Dave Hello
61ae478c38
[Doc] Add current version on the top of README 2016-11-16 21:23:20 +08:00
Qiangjun Ran
2a2b8bdeb3
[Robustness] use backslash when sourcing in case of overridden dot
Fixes #1278.
2016-11-03 23:44:20 -07:00
Peter Dave Hello
f3cddf8271 [Doc] Bold leading "Note:" in readme for readability 2016-10-28 11:20:12 +08:00
Jordan Harband
589a9112bd
v0.32.1 2016-10-18 13:16:51 -07:00
sunxiaobo
a338f98a5a accerlate nvm invoke when change directory 2016-10-14 16:31:26 +08:00
Joseph Frazier
7ca1186dbc Fix "Manual upgrade" link in readme 2016-09-27 21:40:36 -04:00
Peter Dave Hello
8b3cf6cbcb add a menu for readme for easier readability 2016-09-18 16:10:21 +08:00
Erez Zukerman
4a7973ea61
Removes fin from the readme
If you go to the [fin repo](https://github.com/fisherman/fin) you'll see that it isn't a node version manager, but simply a plugin manager for Fish. Seems out of scope for the readme, and there are other plugin solutions for fish as well. I suggest removing the reference.
2016-09-13 10:25:17 -04:00
Peter Dave Hello
ef5670fd82 Bump to require git v1.7+ and add docs, fix #1232 2016-09-17 13:23:04 +08:00
b264
9db5c06a63 [Docs] copyedit readme 2016-09-16 16:19:55 -05:00
Jordan Harband
63fe22d635
v0.32.0 2016-09-15 15:02:56 -07:00
Jordan Harband
25fa40e7cb
v0.31.7 2016-09-02 23:43:04 -07:00
Jordan Harband
31c68adbcf
v0.31.6 2016-08-23 14:36:15 -07:00
Jordan Harband
d179810b25
v0.31.5 2016-08-23 11:12:21 -07:00
Jordan Harband
1ac7e236b1 [New] Add lts/foo support to remote commands.
- `nvm ls-remote`
 - `nvm version-remote`
 - `nvm install`
 - `nvm uninstall`

Document existing support:
 - `nvm use`
 - `nvm exec`
 - `nvm run`

Fixes #1208.
2016-08-23 10:58:00 -07:00
Jordan Harband
31e58d1827
v0.31.4 2016-07-29 16:54:13 -07:00
Joe Lencioni
f51b1bf8ae Document required git version
git-describe was taught `--abbrev=0` in 1.5.0:

  https://github.com/git/git/blob/master/Documentation/RelNotes/1.5.0.txt

git-describe was taught `--match` in 1.5.5:

  https://github.com/git/git/blob/master/Documentation/RelNotes/1.5.5.txt

I don't see anything else potentially weird in here, so I think it is
safe to proclaim that the minimum git version required to run these
commands is 1.5.5.

Documenting this minimum version required here should help people debug
possible issues and help maintainers of this project understand the
impacts of modifying these commands in the future.
2016-07-28 10:51:00 -07:00
Joe Lencioni
6eef4ce4d2 Use NVM_DIR in installation instructions
As suggested by @ljharb, this might be a little cleaner. I'm not
entirely sure, but in any case, it is consistent with the upgrade
instructions, so that is nice.
2016-07-28 10:36:51 -07:00
Joe Lencioni
54476476ab Use subshells for installation and upgrade instructions
I recently upgraded my copy of nvm and I was disappointed to be dropped
in the .nvm directory at the end of it. I also didn't like having to
copy and paste two separate blocks of code into my terminal, because I
missed the second one the first time around and was left in a slightly
confusing state. So, I decided to make this easier by utilizing
subshells and moving all of the instructions into one code block in this
document. I think this will improve people's experience maintaining this
tool.
2016-07-28 10:36:51 -07:00
Joe Lencioni
87a3a4425d Ensure git describe only matches version tags
`git describe` will match the latest tags, regardless of what it looks
like. We can make this a little safer by adding a `--match` flag to
match tags that look like version tags. This allows the maintainers of
this repo to more safely add other types of tags if they so wish,
without causing people to install or upgrade to those versions.
2016-07-28 10:36:51 -07:00
Joe Lencioni
17a3272b8a Ensure git describe gives latest tag
I recently ran the upgrade instructions and I ended up with the version
I was already on. This happened because `git describe` describes a
commit using the most recent tag reachable from it. Since I already had
a tag checked out, it was describing the tag I had already checked out.

Thankfully, `git describe` accepts an optional commit-ish, which it will
use instead of what we have currently checked out. Testing this in my
terminal now gives me the latest tag on origin, which is what I am
interested in when updating to the latest version.

  ~/.nvm ❯❯❯ git describe --abbrev=0 --tags
  v0.30.1
  ~/.nvm ❯❯❯ git describe --abbrev=0 --tags origin
  v0.31.3

I also added it to the manual install instructions for consistency and
extra safety.
2016-07-28 10:36:51 -07:00
Luke Childs
c08010f610 Fix typo in readme 2016-07-28 17:48:23 +01:00
wiserweb
6ac7ecf7dc Update README.markdown
Specifies the lines that will be added by the installation script.
2016-07-26 02:31:07 -04:00
Luke Childs
a09f225ec7 Update zsh-nvm upgrade command in readme 2016-07-24 21:13:51 +01:00
Jordan Harband
a539cba11e v0.25.3 2015-05-22 15:18:46 -07:00
Jordan Harband
96c96ec714 v0.25.2 2015-05-19 14:05:43 -07:00
Jordan Harband
f70530ef18 Fix installation instructions. 2015-05-07 10:43:47 -07:00
Jordan Harband
ec33e8b720 v0.25.1 2015-05-03 15:31:54 -07:00
Jordan Harband
eb5cecc970 v0.25.0 2015-04-26 12:58:05 -07:00
Jordan Harband
36f933984d Remove trailing whitespace. 2015-04-25 11:21:33 -07:00
Marc-Aurèle DARCHE
4612d8d827 Remove source bashism
Using `.` and not `source`, since it's more portable

cf. #704 and https://wiki.ubuntu.com/DashAsBinSh#source
2015-04-19 16:25:34 +02:00
Shane Keulen
7ea15a7618 Added compatibility issues section
Sections includes warnings for cretain nonstandard path settings and environment variables that conflict with nvm.
2015-04-13 16:54:20 -04:00
Jordan Harband
c966204cd6 v0.24.1 2015-04-05 12:55:17 -07:00
Jordan Harband
5802ac3ea7 v0.24.0 2015-03-05 21:35:37 -08:00
Félix Saparelli
2db71a85a5 Move mention of Fish near the Windows alternatives 2015-02-08 11:31:31 +13:00
Félix Saparelli
64b16faf72 Point fish users in the right direction 2015-02-08 11:05:21 +13:00
Jordan Harband
0f1f3ed29c v0.23.3 2015-02-02 20:26:00 -08:00
G. Kay Lee
3e74bac964 Update README.markdown
Add link to io.js repo as suggested in #618
2015-01-25 15:29:36 +08:00
Jordan Harband
1eaf6b53e4 v0.23.2 2015-01-23 13:53:03 -08:00
Jordan Harband
8822bd719a v0.23.1 2015-01-23 02:08:36 -08:00
Jordan Harband
d90c1eca39 Remove trailing whitespace 2015-01-23 02:08:13 -08:00
yelo
c8f712a334 add iojs mirror to README 2015-01-23 11:18:51 +08:00
Mikeal Rogers
0471d0ffd6 Adding iojs to README.
Not entirely sure this is the best place for this but it was the best I could find.
2015-01-20 10:21:18 -05:00
Jordan Harband
43a7d78693 v0.23.0 2015-01-19 22:15:06 -08:00
Jacob Hoffman-Andrews
896a7eddd3 Move some URLs to HTTPS. 2015-01-18 12:05:44 -08:00
Jordan Harband
448bd38a55 v0.22.2 2015-01-14 15:44:40 -08:00
Jordan Harband
0a142b7e7a v0.22.1 2015-01-10 19:43:36 -08:00
Jordan Harband
c91e8d0ba2 v0.22.0 2014-12-26 16:30:21 -08:00
Jordan Harband
bef3a5ce3a v0.21.0 2014-12-22 12:03:33 -08:00
Jordan Harband
f408d68afc Add nvmrc note to nvm which blurb. 2014-12-17 01:30:23 -08:00
Daniel Bretoi
7805492bda merge with master 2014-12-02 13:01:37 -08:00
Jordan Harband
8964cb46d3 v0.20.0 2014-11-29 11:23:16 -08:00
Jordan Harband
7bbcd3a977 v0.19.0 2014-11-23 14:49:38 -08:00
Jordan Harband
e728577627 Rename nvm copy-packages to nvm reinstall-packages, and --copy-packages-from install option to --reinstall-packages-from
For #341. `nvm copy-packages` and install option `--copy-packages-from` will continue to be supported for for at least a full minor release version.
2014-11-22 13:22:24 -08:00
Daniel Bretoi
c9a53fe0c7 include nvm which in documentaiton 2014-11-21 17:55:46 -08:00
Jordan Harband
5f5eb47f14 v0.18.0 2014-11-05 10:59:59 -08:00
Jordan Harband
601490ac1d Merge tag 'v0.17.3' 2014-10-20 15:50:47 -07:00
Jordan Harband
4748b3a236 v0.17.3 2014-10-20 15:48:49 -07:00
Jordan Harband
a7b1f93592 README cleanup: Use the Oxford comma, properly lowercase commands 2014-10-19 19:26:17 -07:00
Jordan Harband
ca89cceb99 Default $NVM_SYMLINK_CURRENT to off (create a "current" symlink on use).
Fixes #499.
2014-10-14 18:14:12 -07:00
Corey Butler
2edc86d574 Fixed links
The links were relative to github.com/creationix/nvm/master instead of the intended sites.
2014-10-05 10:15:10 -05:00