diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 6 insertions, 11 deletions
@@ -10,19 +10,14 @@ required. ## Usage -Craft is used as a Git hook. It can be enabled for a given Git repository and -hook by creating a symbolic link: +Call the `craft` tool like this: ``` -ln -s path/to/craft path/to/repository/.git/hooks/post-receive +./craft -repo https://example.com -commit 8f36088eee1cfbec4ddac4d652101db3b29eed45 ``` -Currently only the `post-receive` hook is supported. This can be performed also -with a bare repository: +This will create a temporary directory, clone the repository including +submodules to that location, execute the `build` function from the `craft.sh` +file inside the root of the repo and remove the temporary directory. -``` -ln -s path/to/craft path/to/bare/repository.git/hooks/post-receive -``` - -Whenever such a repository received updates via `git push` craft will be -executed and prints text to the console of the user who pushed the updates. +Log output is redirected to the calling terminal. |