Skip to content

Commit be3b54b

Browse files
author
Zsolt Gál
committed
update readme
1 parent 7c318a0 commit be3b54b

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
11
# php-cli-cross-platform-open
22
Opens a file or URL in the user's preferred application in CLI (cross platform)
3+
4+
## usage
5+
6+
```
7+
<?php
8+
9+
use Technodelight\CliOpen\OsAdaptingFactory;
10+
$cliOpen = OsAdaptingFactory::create();
11+
$cliOpen->open('https://packagist.com');
12+
```
13+
14+
## requirements
15+
16+
You need one of the following terminal applications available:
17+
18+
- open (OS X default)
19+
- xdg-open (default in some linux distros)
20+
- opn / open-cli (https://github.com/sindresorhus/open-cli)

0 commit comments

Comments
 (0)