Skip to content

Commit bfe4876

Browse files
committed
update readme
1 parent 414dc9d commit bfe4876

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@
44
/composer.phar
55
/phpunit.xml
66
/satis.phar
7-
.idea
7+
/.idea
8+
/satis.json
9+
/public/
10+

README.md

+30
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,33 @@
1+
# 如何使用
2+
在项目根目录创建一个配置文件satis.json
3+
```json
4+
{
5+
"name": "My Private Composer Repository",
6+
"homepage": "http://your.domain.com",
7+
"repositories": [
8+
{
9+
"type": "git",
10+
"url": "https://github.com/yonh/satis.git"
11+
}
12+
],
13+
"require": {
14+
"yonh/satis": "*"
15+
},
16+
"archive": {
17+
"directory": "dist",
18+
"format": "tar",
19+
"skip-dev": false,
20+
"prefix-url": "http://your.domain.com"
21+
}
22+
}
23+
```
24+
使用命令生成生成仓库列表
25+
```bash
26+
# ./public可自定义
27+
php bin/satis build satis.json ./public
28+
```
29+
30+
131
# Satis
232

333
Simple static Composer repository generator.

0 commit comments

Comments
 (0)