From 86b48bf8e023705de21afabbbf2961b0b3cf9ec5 Mon Sep 17 00:00:00 2001
From: Eike Kettner <eike.kettner@sdsc.ethz.ch>
Date: Tue, 2 Jul 2024 16:19:08 +0200
Subject: [PATCH] Readme update

---
 README.md       | 9 +++++++--
 src/cli/opts.rs | 3 +++
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e36e92e..f046695 100644
--- a/README.md
+++ b/README.md
@@ -8,14 +8,19 @@
   - [x] for publishing (what/how exactly? assume to upload a binary to
         the github release page)
   - [x] for testing an all platforms
-- [ ] contributing.md (check mold)
-- [ ] add tokio and async all the things
+- [x] contributing.md (check mold)
+- [x] add tokio and async all the things
 - [ ] user documentation
   - the `--help` is good for a quick and to-the-point documentation of
     the cli, but there must also be something more elaborate
   - this documentation should contain example runs of the cli and it's
     output and this must be generated by running the examples
   - bad user experience are invalid examples in the docs
+  - silent code blocks
+- [ ] getting started guide (what to download, how to run etc)
+- [ ] rename binary to `rnk`
+- [ ] test on mac and windows
+- [ ] check to create a mac package
 - [ ] nice to have: clone a project / repo
 - [ ] think better what is `pub` and what is not, thinking about
       providing a rust library alongside the cli maybe
diff --git a/src/cli/opts.rs b/src/cli/opts.rs
index afeee08..c4c7384 100644
--- a/src/cli/opts.rs
+++ b/src/cli/opts.rs
@@ -60,6 +60,9 @@ pub enum SubCommand {
 /// options are available to all sub-commands and must appear before
 /// them. Each sub command has its own set of flags/options and
 /// arguments.
+///
+/// Repository: https://github.com/SwissDataScienceCenter/renku-cli
+/// Issue tracker: https://github.com/SwissDataScienceCenter/renku-cli/issues
 #[derive(Parser, Debug)]
 #[command(name = "renku-cli", version)]
 pub struct MainOpts {