skills.rest
CloudyWing
CloudyWingCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

create-license-and-readme-link

Create a LICENSE file and update README links for code repositories.

Updated Mar 1, 2026
Search Tags:#automation#git#github#readme#repository#license#open-source
One-click install
npx skills add https://github.com/CloudyWing/ai-dotfiles --skill create-license-and-readme-link
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-license-and-readme-link
Source: https://github.com/CloudyWing/ai-dotfiles/tree/main/skills/create-license-and-readme-link
Command: npx skills add https://github.com/CloudyWing/ai-dotfiles --skill create-license-and-readme-link

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many repositories lack a clear open-source license or an accurate README link to the license, causing legal ambiguity and discouraging contribution; this Skill automates choosing an appropriate license and ensuring the repository contains a proper LICENSE file and README reference.

Core Features & Use Cases

  • Project inspection: Detects README content and common project manifests (package.json, pyproject.toml, *.csproj) to infer project type and language.
  • License recommendation: Provides up to three recommended licenses with rationale tailored to libraries, applications, portfolios, or public-domain intents.
  • License creation and substitution: Retrieves standard license text when available, replaces placeholders ([year], [fullname]) using git config or user input, writes a UTF-8 (no BOM) LICENSE file, and optionally replaces existing LICENSE after confirmation.
  • README integration: Locates existing license badges or text and updates their links, or merges a localized license section at the README end if none exists.
  • Use Case: Quickly add a permissive MIT license to a new JavaScript library and update the README badge to point to the new LICENSE file.

Quick Start

Run the create-license-and-readme-link skill to detect your repository type, review recommended licenses, generate a LICENSE file with correct year and author, and update README links accordingly.

Frequently Asked Questions about create-license-and-readme-link

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add an open-source license to my GitHub repository and update my README?▼

To add an open-source license and update your README, this Skill inspects project manifests like package.json or pyproject.toml, generates a LICENSE file with standard text, and merges a localized license section or badge into README.md.

What is the best way to populate a LICENSE file with the correct author and year?▼

The best way to populate a LICENSE file is by retrieving standard license text and automatically replacing placeholders like [year] and [fullname] using your git config or user input, then saving the file as UTF-8 without BOM.

Does this license generation tool work with Python and JavaScript projects?▼

Yes, license generation works with Python and JavaScript projects by detecting common manifests such as package.json, pyproject.toml, or .csproj to infer the project type and recommend an appropriate license.

How does the tool choose which open-source license to recommend for my code?▼

The tool recommends an open-source license by analyzing your repository type and project manifests, providing up to three tailored options with rationale for libraries, applications, portfolios, or public-domain intents.

Can I automatically update an existing license badge in my README?▼

Yes, you can automatically update an existing license badge in your README. The tool locates existing license badges or text and updates their links, or merges a new localized license section at the README end if none exists.

Will the generated LICENSE file overwrite my current one without asking?▼

No, the generated LICENSE file will not overwrite your current one without asking. The tool optionally replaces an existing LICENSE file only after receiving your explicit confirmation during the generation process.

Related Skills

Explore More Software Engineering Skills→
tomzxtomzx
5

write-readme

Generate a ready-to-commit README.md from project metadata using a fixed Markdown template.

Community
Intermediate
mattg101mattg101
1

gcp-copy

Stage all changes, commit with a message, and push to a remote Git repository.

Community
Basic
edfentonedfenton
3

shared-readme

Generate structured README.md files from project metadata for MERN or iOS projects.

Community
Basic
toilahuonggtoilahuongg
10

readme

Update README.md with documentation from codebase analysis.

Community
Basic