Skip to content

Commit 338a791

Browse files
committed
Update readme
1 parent 43ec9a2 commit 338a791

1 file changed

Lines changed: 26 additions & 17 deletions

File tree

README.md

Lines changed: 26 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,35 @@
1+
# Phug Split
12

2-
Phug
3-
========
3+
[![Latest Stable Version](https://img.shields.io/packagist/v/phug/split.svg?style=flat-square)](https://packagist.org/packages/phug/split)
4+
[![Build Status](https://img.shields.io/travis/phug-php/split/master.svg?style=flat-square)](https://travis-ci.org/phug-php/split)
45

5-
[![Latest Stable Version](https://poser.pugx.org/phug/phug/v/stable.png)](https://packagist.org/packages/phug/phug)
6-
[![Monthly Downloads](https://poser.pugx.org/phug/phug/d/monthly)](https://packagist.org/packages/phug/phug)
7-
[![Build Status](https://travis-ci.org/phug-php/phug.svg?branch=master)](https://travis-ci.org/phug-php/phug)
8-
[![Test Coverage](https://codeclimate.com/github/phug-php/phug/badges/coverage.svg)](https://codeclimate.com/github/phug-php/phug/coverage)
6+
**Split** is a tool to handle a mono-repo that can be downloaded as single package,
7+
multiple packages or both.
98

10-
[![Code Climate](https://codeclimate.com/github/phug-php/phug/badges/gpa.svg)](https://codeclimate.com/github/phug-php/phug)
11-
[![Issue Count](https://codeclimate.com/github/phug-php/phug/badges/issue_count.svg)](https://codeclimate.com/github/phug-php/phug)
12-
[![StyleCI](https://styleci.io/repos/74360844/shield?branch=master)](https://styleci.io/repos/74360844)
9+
## Install
1310

14-
[Detailed status](https://gist.github.com/kylekatarnls/8720155b06b016f8128ff511b8695532)
11+
```shell script
12+
composer require phug/split
13+
```
1514

16-
What is Phug?
17-
-----------------
15+
## Usage
1816

19-
Phug is the PugJS Template Engine for PHP.
17+
Put **composer.json** files in sub-directory of a main package repository.
2018

21-
Not just a port. It's written from scratch as a native PHP template engine.
19+
```shell script
20+
vendor/bin/split update
21+
```
2222

23-
Documentation
24-
------------
23+
Check options with:
24+
```shell script
25+
vendor/bin/split update --help
26+
```
2527

26-
https://www.phug-lang.com/
28+
Check other commands with:
29+
```shell script
30+
vendor/bin/split --help
31+
```
32+
33+
## Example
34+
35+
https://github.com/phug-php/phug

0 commit comments

Comments
 (0)