asdf/README.md
James Hegedus 65aa5abe4e
de-dupe readme and finalise docs site (#441)
* save old readme for migration purposes

* promote new readme

* use the repo readme from the doc site homepage

* mention extendable plugin system in title and old plugin support

* improve subtitles english

* update links to direct users to the site!

* add link to docs site in readme until github repo site link is populated

* update troublesome contributing section
2019-01-29 22:31:34 +11:00

30 lines
1.5 KiB
Markdown

# asdf-vm [![Build Status](https://travis-ci.org/asdf-vm/asdf.svg?branch=master)](https://travis-ci.org/asdf-vm/asdf)
**Manage multiple runtimes with a single CLI tool, extendable via plugins** - [docs site](https://asdf-vm.github.io/asdf/)
asdf-vm is a CLI tool that can manage multiple language runtimes on a per-project basis. It is like `gvm`, `nvm`, `rbenv` & `pyenv` (and more) all in one! Simply install your language's plugin!
## Why use asdf-vm?
- single CLI for multiple languages
- consistent commands to manage all your languages
- single global config keeping defaults in one place
- single `.tool-versions` config file per project
- support for existing config files `.node-version`, `.nvmrc`, `.ruby-version` for easy migration
- automatically switches runtime versions as you trasverse your directories
- simple plugin system to add support for your language of choice
- completion scripts managed by the plugin, not you!
## Documentation
[Please head over the documentation site for more information](https://asdf-vm.github.io/asdf/)!
- [Getting Started](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm)
- [All Commands](https://asdf-vm.github.io/asdf/#/core-commands)
- [All Plugins](https://asdf-vm.github.io/asdf/#/plugins-all)
- [Create a Plugin](https://asdf-vm.github.io/asdf/#/plugins-create)
## Contributing
See [CONTRIBUTING.md in the repo](https://github.com/asdf-vm/asdf/blob/master/CONTRIBUTING.md) or the [Contributing section on the docs site](http://asdf-vm.github.io/asdf/#/contributing-core-asdf-vm).