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

Improve top section of the README file #28

Closed
Angelmmiguel opened this issue Mar 2, 2022 · 3 comments · Fixed by #29
Closed

Improve top section of the README file #28

Angelmmiguel opened this issue Mar 2, 2022 · 3 comments · Fixed by #29
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Angelmmiguel
Copy link
Owner

To improve the README file, let's add the GitHub actions and release badge and a screenshot.

@Angelmmiguel Angelmmiguel added the documentation Improvements or additions to documentation label Mar 2, 2022
@Angelmmiguel Angelmmiguel self-assigned this Mar 2, 2022
@Angelmmiguel
Copy link
Owner Author

The screenshot to add:

Fu example screenshot

@Angelmmiguel
Copy link
Owner Author

A better and compressed screenshot:

fu CLI screenshot

@Angelmmiguel
Copy link
Owner Author

Use a smaller screenshot:

fu CLI screenshot

Angelmmiguel added a commit that referenced this issue Mar 2, 2022
* [#28] feat: add a screenshot and badges to the README

* [#28] chore: reduce image size in the README
@Angelmmiguel Angelmmiguel added this to the v1.0.0 milestone Mar 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant