From b41908f40d7d4d0118406a0dce9cab96a8a7a46c Mon Sep 17 00:00:00 2001 From: Laura Liberda Date: Tue, 23 Feb 2021 23:19:58 +0100 Subject: [PATCH] updated readme --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e982cfe..dcf86cd 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ Copykitku is a tool for replicating issues, merge requests or specific commits, also between various source code management tools (namely: GitHub and GitLab, but the list could be expanded). -Example usage: +Created for simplifying [haruhi-dl](https://haruhi.download/) development. + +## Example usage ``` $ copykitku replicate https://github.com/ytdl-org/youtube-dl/issues/27483 https://git.sakamoto.pl/laudompat/haruhi-dl @@ -10,4 +12,13 @@ $ copykitku replicate https://github.com/ytdl-org/youtube-dl/issues/27483 https: Replicated successfully: https://git.sakamoto.pl/laudompat/haruhi-dl/-/issues/39 ``` -Created for simplifying [haruhi-dl](https://haruhi.download/) development. +See `copykitku --help` for more usage docs. + +## Supported services + +- [GitHub](https://github.com/) (including Enterprise Server) +- [GitLab](https://about.gitlab.com/) + +## `.copykitkurc.toml` project config file + +See `CopykitkuProjectConfig` type definition in [src/types.ts](/src/types.ts)