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

Update README to add demo and stats #139

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Update README to add demo and stats #139

wants to merge 7 commits into from

Conversation

m2rads
Copy link
Contributor

@m2rads m2rads commented Dec 24, 2024

Added

  • Demo video
  • Stars
  • npm version
  • Monthly downloads

Copy link

vercel bot commented Dec 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
shortest ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 24, 2024 11:15pm

@m2rads m2rads marked this pull request as draft December 24, 2024 19:24
@m2rads m2rads requested review from rmarescu and slavingia December 24, 2024 19:31
@m2rads
Copy link
Contributor Author

m2rads commented Dec 24, 2024

So seems like adding the demo to Github assets is not working. I think we should upload the video to the repo.

@m2rads
Copy link
Contributor Author

m2rads commented Dec 24, 2024

Fixed

@m2rads m2rads marked this pull request as ready for review December 24, 2024 19:47
README.md Outdated
@@ -1,6 +1,13 @@
# Shortest
**[shortest.com](https://shortest.com)**

![GitHub Repo stars](https://img.shields.io/github/stars/anti-work/shortest?style=social)      [![npm version](https://img.shields.io/npm/v/@antiwork/shortest)](https://www.npmjs.com/package/@antiwork/shortest)      [![Downloads](https://img.shields.io/npm/dm/@antiwork/shortest)](https://www.npmjs.com/package/@antiwork/shortest)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally think we should copy Firecrawl's approach, keeping the stars separate and having a CTA to like. I don't think including the stars by itself helps as it's already above. Wdyt?

Copy link
Contributor Author

@m2rads m2rads Dec 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could add the Logo at the top and show the link to the website like how Firecrawl does. Just double checking would you like to add the rest of the stats like Firecrawl or the Logo and the demo video is enough for now?

image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could add the logo as it's already in the repo. Nextjs does similarly

README.md Outdated

AI-powered natural language end-to-end testing framework.
<p align="center">
<img src="https://github.com/user-attachments/assets/0adf7c5d-296f-46a5-8071-57c408f02d43" alt="Shortest Logo" width="200" />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should use an SVG to mirror the app, or it doesn't work? Also, should be orange, the hex code equivalent of text-orange-500

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants