From f59a98e473d4c24cdc05b94bfe139b519c2c5edb Mon Sep 17 00:00:00 2001 From: Yasunari Watanabe Date: Mon, 6 Dec 2021 12:40:38 +0800 Subject: [PATCH] opam: edit synopsis and add instructions --- README.md | 9 +++++---- monorobot.opam | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8cee9e8e..8409da00 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,16 @@ A Slackbot for GitHub monorepos. Configure how repo notifications should be rout ## Setting Up -Install dependencies via OPAM. +Install via OPAM: -```sh -opam install --deps-only . +``` +opam install monorobot ``` -Then, build with Dune. +Or install dependencies and build locally: ```sh +opam install --deps-only . make ``` diff --git a/monorobot.opam b/monorobot.opam index f1271c68..e2bb54b4 100644 --- a/monorobot.opam +++ b/monorobot.opam @@ -1,7 +1,7 @@ opam-version: "2.0" name: "monorobot" version: "0.1" -synopsis: "Notification bot" +synopsis: "Notification bot for monorepos" description: "Notification bot to handle webhook events and post notifications to Slack." maintainer: "Ahrefs " authors: "Ahrefs "