Adds develop command documentation to Readme

rubyists · Feb 4, 2024 · 75a34ad · 75a34ad
1 parent 1c1e6aa
commit 75a34ad
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,13 +2,19 @@
 
 ## [Unreleased]
 
+## [0.5.4] - 2024-02-04
+
 ## [0.5.3] - 2024-02-03
+### Added
+- Added support for multiline descriptions without failing (@bougyman)
+
 ### Changed
 - Changed default branch to use upstream default branch name (@bougyman)
 
 ## [0.5.2] - 2024-02-03
 ### Added
 - Added new changelog management system (changelog-rb) (@bougyman)
 
-[Unreleased]: https://github.com/rubyists/linear-cli/compare/v0.5.3...HEAD
+[Unreleased]: https://github.com/rubyists/linear-cli/compare/0.5.4...HEAD
+[0.5.4]: https://github.com/rubyists/linear-cli/compare/v0.5.3...0.5.4
 [0.5.3]: https://github.com/rubyists/linear-cli/compare/v0.5.2...v0.5.3
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    linear-cli (0.5.3)
+    linear-cli (0.5.4)
       base64 (~> 0.2)
       dry-cli (~> 1.0)
       dry-cli-completion (~> 1.0)

diff --git a/Readme.adoc b/Readme.adoc
@@ -82,6 +82,7 @@ $ lc w --teams
 ----
 $ lcls
 $ lcls --full
+$ lcls -f CRY-1
 ----
 
 ==== Assign one or more issues to yourself (take em!)
@@ -100,7 +101,21 @@ $ lc issue take CRY-456 CRY-789
 
 [source,sh]
 ----
-$ lc i c --title "My new issue" --description "This is a new issue"
+$ lc i c --title "My new issue" --description "This is a new issue" --labels Bug,Feature --team CRY
+$ lc i c -t "My new issue" -T CRY -l Improvment,Feature
 ----
 
-NOTE: If you don't provide a title or description, you will be prompted to enter them.
+NOTE: If you don't provide a title, team, labels or description, you will be prompted to enter them.
+
+==== Develop an issue
+
+This will switch to the branch for the issue, creating the branch if it doesn't exist.
+
+'dev' is a shortcut for the 'develop' subcommand of the issue command
+
+[source,sh]
+----
+$ lc i dev CRY-1234
+----
+
+TIP: You may pass the --dev option to the create subcommand to immediately develop the creted issue.
diff --git a/changelog/0.5.3/added_support_for_multiline_descriptions_without_failing.yml b/changelog/0.5.3/added_support_for_multiline_descriptions_without_failing.yml
@@ -0,0 +1,4 @@
+type: Added
+title: >
+  Added support for multiline descriptions without failing
+author: bougyman
diff --git a/changelog/0.5.4/tag.yml b/changelog/0.5.4/tag.yml
@@ -0,0 +1 @@
+date: 2024-02-04