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

Enhance README.md #33

Open
aryanmehrotra opened this issue May 3, 2024 · 1 comment
Open

Enhance README.md #33

aryanmehrotra opened this issue May 3, 2024 · 1 comment
Labels
good first issue Good for newcomers

Comments

@aryanmehrotra
Copy link
Member

Update readme.md with website UI, and add different tags as needed.

@aryanmehrotra aryanmehrotra changed the title Enhance readme.MD Enhance README.md May 3, 2024
@aryanmehrotra aryanmehrotra added the good first issue Good for newcomers label May 3, 2024
@SanjanaBankar
Copy link

Hello,

I'm reaching out to you regarding optimizing the README file.

Is your feature request related to a problem? Please describe.
After reviewing the current README, there's significant room for improvement to make it more engaging, informative, and user-friendly.

Describe the solution you'd like
I'll ensure that the instructions for getting started are concise, easy to follow, and include commands for installing dependencies and running the development server. I'll provide clear guidance on customizing the project by editing files in the /src folder, empowering users to tailor the project to their needs effortlessly. I'll highlight the global search feature, powered by the FlexSearch library, emphasizing its accessibility and ease of use with a keyboard shortcut (⌘K) also include links to relevant documentation and resources for further learning about the technologies used in the project, such as Tailwind CSS, Next.js, and more.

I'm eager to take on this task and look forward to the opportunity to contribute to this project.

Please assign me this issue under GSSOC24

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

No branches or pull requests

2 participants