Conversation
Readme jumped straight into Installation with no intro on what the tool does or why you'd want it. Lead with a one-line description, the old Ruby repo's demo gif (same UX), and the concurrency win as the concrete why - installation/usage details now come after, not before. Closes #45. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates Readme.adoc to better explain what the Linear CLI does and why to use it before diving into installation and usage details (per #45).
Changes:
- Adds an upfront one-line product description and reorders the introduction ahead of installation.
- Embeds the existing demo GIF (
cinemas/listings.cinema.gif) near the top of the README. - Highlights the “real concurrency” benefit (
Task.async_stream) with a concrete example.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| A command line interface to https://linear.app - list, take, create, develop, | ||
| and update issues without leaving your terminal. | ||
|
|
||
| image::cinemas/listings.cinema.gif[] |
Comment on lines
+21
to
+22
| issues at once. Looking up 10 issues by id, for example, runs in ~1.5s here | ||
| vs ~5s doing it one at a time. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #45.
Readme jumped straight into Installation with no intro on what the tool does or why you'd want it. Lead with a one-line description, the old Ruby repo's demo gif (
cinemas/listings.cinema.gif- same UX, sincelclsbehaves identically), and the concurrency win as the concrete why (10 issues by id: ~1.5s here vs ~5s doing it one at a time, measured earlier this session). Installation/usage details now come after, not before.Test plan
asciidoctor -o /dev/null Readme.adocrenders clean