Skip to content

πŸ“‹ [META] Add LICENSE, badges, and repository topicsΒ #2

@codeme-ne

Description

@codeme-ne

Problem

Missing professional polish that signals a maintained, serious project:

  • ❌ No LICENSE file (legally unclear for recruiters/companies)
  • ❌ No badges in README header
  • ❌ No repository topics (hurts discoverability)

Solution

1. Add MIT LICENSE

Create LICENSE file:

MIT License

Copyright (c) 2024 Lukas Zangerl

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

2. Add Badges to README Header

[![Live Demo](https://img.shields.io/badge/demo-live-brightgreen)](https://checkst-bot.vercel.app)
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0-blue)](https://www.typescriptlang.org/)
[![Next.js](https://img.shields.io/badge/Next.js-14-black)](https://nextjs.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![OpenAI](https://img.shields.io/badge/OpenAI-GPT--4-412991)](https://openai.com/)
[![Pinecone](https://img.shields.io/badge/Pinecone-Vector_DB-00ADD8)](https://www.pinecone.io/)

3. Add Repository Topics

Go to repo Settings β†’ Topics and add:

  • ai
  • rag
  • retrieval-augmented-generation
  • openai
  • pinecone
  • typescript
  • nextjs
  • learning
  • education
  • langchain

Impact

HIGH - Badges provide instant credibility. LICENSE is essential for professional projects. Topics improve GitHub search discoverability.

Effort

~5 minutes


Labels: enhancement, documentation, good first issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions