Update README with config information

Athos
1 parent 297939d1
Showing 1 changed file with 13 additions and 0 deletions Show diff stats
README.md
@@ -46,3 +46,16 @@ plackup [--port PORT_NUMBER] -Ilib
 ```
 plackup -Ilib
 ```
+
+----
+# Configuration
+
+> The file config.yaml sets all the needed parameters:
+
+* User: Copr user, the owner of the repository to be watched
+* UpdateRate: Rate in witch information on Git and Copr are updated
+* GitDomain: Forge system used to host git repositories, like github or gitlab.
+* GitSpecPath: Path to spec files in the git repository: use <branch> instead of the branch name and <package> instead of package names.
+* Repositories: name of Copr repositories for User.
+* Branches: name of git branches to be watched.
+
...	...	@@ -46,3 +46,16 @@ plackup [--port PORT_NUMBER] -Ilib
46	46	```
47	47	plackup -Ilib
48	48	```
	49	+
	50	+----
	51	+# Configuration
	52	+
	53	+> The file config.yaml sets all the needed parameters:
	54	+
	55	+* User: Copr user, the owner of the repository to be watched
	56	+* UpdateRate: Rate in witch information on Git and Copr are updated
	57	+* GitDomain: Forge system used to host git repositories, like github or gitlab.
	58	+* GitSpecPath: Path to spec files in the git repository: use <branch> instead of the branch name and <package> instead of package names.
	59	+* Repositories: name of Copr repositories for User.
	60	+* Branches: name of git branches to be watched.
	61	+
...	...