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

docs: Update Readme file #7

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

Conversation

mendoncamaria
Copy link

  • My pull request targets the main branch of talk-timer.
  • I have read and followed the contribution guidelines

Closes #3

Copy link

vercel bot commented Oct 18, 2024

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

Name Status Preview Comments Updated (UTC)
talk-timer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 19, 2024 3:46am


First, run the development server:
<div>
Copy link
Owner

Choose a reason for hiding this comment

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

Let's get rid of this section.

NextJS + shadcn/ui

### Deployment Platform
Vercel
Copy link
Owner

Choose a reason for hiding this comment

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

Deployment can be done on any platform, its not just limited to Vercel. It has been deployed to vercel currently.


<h2 id="tech-stack" align="center">⚡️ Tech Stack</h2>

### Frontend Technology
Copy link
Owner

Choose a reason for hiding this comment

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

I don't think this should be a heading.


<h2 id="quick-setup" align="center">⚡️ Quick Setup</h2>

### Fork the project
Copy link
Owner

Choose a reason for hiding this comment

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

Same for these headings. These are steps and not headings

Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
<h2 id="contributing-guidelines" align="center">⚡️ Contributing Guidelines</h2>
<p>
Please refer the CONTRIBUTING.md file for contribution guidelines
Copy link
Owner

Choose a reason for hiding this comment

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

Make the link to the Contributing.md file

Copy link
Owner

Choose a reason for hiding this comment

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

please remove all the screenshots

@dnafication
Copy link
Owner

Thanks for the contribution, looks good but a few suggestions.

  • Please remove all the screenshots
  • If possible add a minimalistic original logo or art which might look good otherwise not needed.
  • Write a general introduction to the project and add the link to the inspiration (https://www.toastmasters.org/resources/timer-zoom-backgrounds)
  • Do not handhold the user for this simple app.

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.

Better docs
2 participants