← Back to team overview

launchpad-reviewers team mailing list archive

[Merge] ~cjwatson/lp-codeimport:charm-readme into lp-codeimport:master

 

Colin Watson has proposed merging ~cjwatson/lp-codeimport:charm-readme into lp-codeimport:master.

Commit message:
charm: Add a basic lp-codeimport description

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~cjwatson/lp-codeimport/+git/lp-codeimport/+merge/439716

Without this, https://charmhub.io/lp-codeimport shows a `README.md` that happens to exist in the `apt` layer, which is confusing.
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~cjwatson/lp-codeimport:charm-readme into lp-codeimport:master.
diff --git a/charm/lp-codeimport/README.md b/charm/lp-codeimport/README.md
new file mode 100644
index 0000000..8e3179c
--- /dev/null
+++ b/charm/lp-codeimport/README.md
@@ -0,0 +1,7 @@
+# Launchpad code import worker
+
+This charm runs a worker to import code from other revision control systems
+into Launchpad.
+
+You will need to set `scheduler_endpoint` to the URL of the code import
+scheduler service in a corresponding Launchpad deployment.