Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change README #118

Merged
merged 9 commits into from
Dec 18, 2023
Merged

Change README #118

merged 9 commits into from
Dec 18, 2023

Conversation

TornaxO7
Copy link
Contributor

So yeah, here's a first step for the README in my opinion: Reduce the amount of text by removing some redundant text.

The reason for this changes are, in my opinion, that users want to which benefits they are getting from this and most people look after crates like this hence they normally should know what a pager is.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: TornaxO7 <[email protected]>
@TornaxO7
Copy link
Contributor Author

I'm quite happy with this. You can merge it, if you want.

@AMythicDev
Copy link
Owner

I think we should keep the Problems with Traditional Pagers section somewhere in the README. It helps in describing why we even started this project at all.

@TornaxO7
Copy link
Contributor Author

I think we should keep the Problems with Traditional Pagers section somewhere in the README. It helps in describing why we even started this project at all.

I added a Motivation section for that

@AMythicDev AMythicDev merged commit a796017 into AMythicDev:main Dec 18, 2023
6 checks passed
@AMythicDev
Copy link
Owner

Merged.

AMythicDev added a commit that referenced this pull request Dec 18, 2023
* doc: adding keybinding entry for toggling follow-mode

* updating readme

* doc: Add follow output mode in README

* doc(REAME): improve features table

* fix(README): typo

Co-authored-by: TornaxO7 <[email protected]>

* fix(README): Formatting issues

* adding motivation section

---------

Co-authored-by: Arijit Dey <[email protected]>
Co-authored-by: Arijit Dey <[email protected]>
@AMythicDev AMythicDev added the A-docs Improvements or additions to documentation label Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants