From 48a1ac7188c8a188f9a0e3c3f5779523fa2305a3 Mon Sep 17 00:00:00 2001 From: Jim Myhrberg Date: Mon, 8 May 2023 01:46:41 +0100 Subject: [PATCH] docs(readme): update features list and examples intro --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index dd3b6f1..89cbe3b 100644 --- a/README.md +++ b/README.md @@ -38,16 +38,17 @@ running [release-please][] in [manifest mode][]. - Focuses on and only supports running release-please's manifest command. - Optionally supports having release-please authenticate as a GitHub App. -- By default places release-please config and manifest files within the - top-level `.github` directory instead of in the repository root: - - `.github/.release-please-manifest.json` - - `.github/release-please-config.json` +- Defaults to looking for release-please's config and manifest files within the + top-level `.github` directory instead of in the repository root. # Examples -All examples here assume you have places your `release-please-config.json` and -`.release-please-manifest.json` within the `.github` folder in the root of the -repository. +All examples assume you have placed your `release-please-config.json` and +`.release-please-manifest.json` within the `.github` directory in the root of +the repository. + +See release-please's [manifest-releaser][manifest mode] documentation for +details about the config and manifest files. ## Basic (Actions Token)