Skip to content

Commit e3a860b

Browse files
committed
Add support for installing via composer
1 parent 76de478 commit e3a860b

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,12 @@ print("hello world!")
5656

5757
## Installation
5858

59-
If you have [basher](https://github.com/basherpm/basher), you can install `mdsh` by running `basher install bashup/mdsh`. Otherwise just clone this repo and copy or link the `mdsh` file to a directory on your `PATH`. (Or just [download the script directly](https://github.com/bashup/mdsh/raw/master/bin/mdsh) to a directory on your `PATH`.)
59+
`mdsh` can be installed in any of the following ways:
60+
61+
* Using [basher](https://github.com/basherpm/basher), via `basher install bashup/mdsh`
62+
* Using [composer](https://getcomposer.org/), via `composer require bashup/mdsh:dev-master` (to add it to your project) or `composer global require bashup/mdsh:dev-master` (to install it globally)
63+
* Using git, by cloning this repo and copying or linking the `bin/mdsh` file to a directory on your `PATH`, or
64+
* Just [downloading the script directly](https://github.com/bashup/mdsh/raw/master/bin/mdsh) to a directory on your `PATH`, then running `chmod +x` on it)
6065

6166
## Usage
6267

composer.json

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "bashup/mdsh",
3+
"license": "MIT",
4+
"description": "Multi-lingual, Markdown-based Literate Shell Programming",
5+
"homepage": "https://github.com/bashup/mdsh/",
6+
"authors": [
7+
{
8+
"name": "PJ Eby",
9+
"homepage": "https://github.com/pjeby"
10+
}
11+
],
12+
"keywords": [
13+
"markdown",
14+
"bash",
15+
"shell-scripting",
16+
"literate-programming"
17+
],
18+
"support": {
19+
"issues": "https://github.com/bashup/mdsh/issues"
20+
},
21+
"scripts": {
22+
"test": "script/test"
23+
},
24+
"bin": [
25+
"bin/mdsh"
26+
]
27+
}

0 commit comments

Comments
 (0)