Skip to content

Commit

Permalink
cleanup readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
alcohol committed Oct 12, 2016
1 parent b092002 commit db145dd
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 41 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2015 Jordi Boggiano, Nils Adermann
Copyright (c) Composer

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
81 changes: 41 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,97 +1,97 @@
Satis - Package Repository Generator
====================================
# Satis

Simple static Composer repository generator.

It uses any composer.json file as input and dumps all the required (according
to their version constraints) packages into a Composer Repository file.

[![Build Status](https://travis-ci.org/composer/satis.svg?branch=master)](https://travis-ci.org/composer/satis)

Usage
-----

## Run from source

- Install satis: `composer create-project composer/satis:dev-master --keep-vcs`
- Build a repository: `php bin/satis build <configuration file> <build-dir>`
- Build a repository: `php bin/satis build <configuration-file> <output-dir>`

Read the more detailed instructions in the [documentation][].

Docker
------

Build and tag the image:
## Run as Docker container

Pull the image:

``` sh
docker build -t composer/satis:latest .
docker pull composer/satis
```

Run the image:

``` sh
docker run --rm -it -v /build:/build composer/satis
```

> Note: by default it will look for a `satis.json` inside the `/build`
directory and output the templates inside `/build/output`.
> Note: by default it will look for a configuration file named `satis.json`
inside the `/build` directory and output the templates inside `/build/output`.

> Note: you can use your host's Composer cache by additionally mounting the
Composer home directory using `-v $COMPOSER_HOME:/composer`.
Run the image (with Composer cache from host):

``` sh
docker run --rm -it -v /build:/build -v $COMPOSER_HOME:/composer composer/satis
```

If you want to run the image without implicitly running Satis, you have to
override the entrypoint specified in the `Dockerfile`:

``` sh
docker run --rm -it --entrypoint /bin/bash composer/satis
docker run --rm -it --entrypoint /bin/sh composer/satis
```

Purge
-----

## Purge

If you choose to archive packages as part of your build, over time you can be
left with useless files. With the `purge` command, you can delete these files.

php bin/satis purge <satis.json> <build-dir>
``` sh
php bin/satis purge <configuration-file> <output-dir>
```

> Note: don't do this unless you are certain your projects no longer reference
any of these archives in their `composer.lock` files.


## Updating

> Note: be careful if you reference your archives in your lock file.
Updating Satis is as simple as running `git pull && composer update` in the
Satis directory.

Updating
--------
If you are running Satis as a Docker container, simply pull the latest image.

Updating is as simple as running `git pull && composer update` in the
satis directory.

Contributing
------------
## Contributing

Please note that this project is released with a [Contributor Code of Conduct][].
By participating in this project you agree to abide by its terms.

Fork the project, create a feature branch, and send us a pull request.

Requirements
------------

PHP 5.6+

Authors
-------
## Authors

Jordi Boggiano - <[email protected]> - <http://twitter.com/seldaek> - <http://seld.be><br />
Nils Adermann - <[email protected]> - <http://twitter.com/naderman> - <http://www.naderman.de><br />

See also the list of [contributors][] who participated in this project.
See also the list of [contributors][] who participate(d) in this project.


## Community Tools

Community Tools
---------------
- [satis-go][] - A simple web server for managing Satis configuration and hosting the generated Composer repository.
- [satisfy][] - Symfony based composer repository manager with a simple web UI.
- [satis-control-panel][] - Simple web UI for managing your Satis Repository with optional CI integration.
- [composer-satis-builder][] - Simple tool for updating the Satis configuration (satis.json) "require" key on the basis of the project composer.json.

License
-------

Satis is licensed under the MIT License - see the LICENSE file for details
## License

Satis is licensed under the MIT License - see the [LICENSE][] file for details


[documentation]: https://getcomposer.org/doc/articles/handling-private-packages-with-satis.md
Expand All @@ -101,3 +101,4 @@ Satis is licensed under the MIT License - see the LICENSE file for details
[satisfy]: https://github.com/ludofleury/satisfy
[satis-control-panel]: https://github.com/realshadow/satis-control-panel
[composer-satis-builder]: https://github.com/AOEpeople/composer-satis-builder
[LICENSE]: https://github.com/composer/satis/blob/master/LICENSE

0 comments on commit db145dd

Please sign in to comment.