jano
Health Uyari
- License — License: MIT
- Description — Repository has a description
- Active repo — Last push 0 days ago
- Low visibility — Only 8 GitHub stars
Code Uyari
- process.env — Environment variable access in .github/scripts/check-pr.js
- fs module — File system access in .github/scripts/check-pr.js
Permissions Gecti
- Permissions — No dangerous permissions requested
Bu listing icin henuz AI raporu yok.
Animated GitHub README banner generator: draws your repo an SVG header that shows what it does, in dark and light mode. A skill for Claude Code, Codex and other AI agents.
English · Español
Jano: a README that explains your repository
Your repo goes in. A README that a stranger understands comes out,
with a moving picture at the top and over each part that needs one.
How it works · What you get · Made with Jano · Install · Use · Limits
Jano is a skill for your AI agent that writes and draws your repository's README. It is for people who own a project and want its front page to explain itself. You call it once, answer a few questions, and it takes your repo along a fixed route: it reads the project, plans each section, writes the text to a size, draws a picture at the top and over the parts that need one, and checks the result before you see it.
How it works
The picture above is the last stop on the route. Here is the whole of it:
- It reads your project. The README, the docs and the code, until it can say who it is for and what it does, in one plain sentence.
- It asks you, once. Who reads the README, what to do with anything marked unfinished and, if your project has a screen, whether one section may show a real screenshot. Then it stops asking.
- It plans every section. Each one gets a job, a word budget and, if it helps, a picture.
- It draws and writes, then measures. Scripts check text size, contrast, smooth loops, section length and links, and Jano fixes what they find.
- A stranger reads it cold. Fresh agents that never saw your project look at each picture without its words, and at the whole README. What they get wrong is redrawn or rewritten.
What you get
- A README planned section by section. Kept in
assets/readme/plan.json, so you can read why each part is there. - Text sized to fit. Each section stays within its word budget; depth that does not fit moves to a page in
docs/. - A moving picture at the top, the hero, that shows what your project does before a word is read.
- A picture over each section that needs one, each showing something of its own.
- Dark and light versions of every picture. GitHub shows each visitor the one that matches their theme.
- Your logo and colours kept, when you have them.
The pictures are plain SVG files that play on GitHub with nothing to install or host.
Made with Jano
Heroes Jano drew for other projects: Anzu, Sharur and Svipall. No two look alike, because no two projects do the same thing.
See all seven, moving, on jano.ilien.dev
The name: Jano is Spanish for Janus, the Roman god of doors, drawn with two faces. A README is the door to a repository, and every picture Jano draws has two faces too, one for dark and one for light.
Install
One command, for Claude Code, Codex, Cursor, Gemini CLI and the other agents the skills CLI supports:
npx skills add ilien-dev/jano
Or, inside Claude Code, as a plugin:
/plugin marketplace add ilien-dev/jano
/plugin install jano@jano
[!IMPORTANT]
Jano needs Python 3.9 or later. With uv that is all; without it, runpip install fonttools brotlionce.
Use
Open your agent in the project and call Jano (/jano in Claude Code, /jano:jano as a plugin, $jano in Codex):
/jano make this repository's README
It asks a few questions, each with the answer it would pick and why. After that it works on its own and tells you what it did; it never commits anything.
You can also ask for less:
/jano make a hero for this repository
/jano make 4 alternatives for this repository's hero
The first draws only the picture at the top and leaves the rest of your README alone. The second opens four different heroes side by side on one page; you keep one, or say what to take from several.
Limits
- The result depends on the AI model that runs it: a stronger model draws better pictures.
- The cold read needs an agent that can start other agents. Without one, Jano tells you the check did not run.
- Every picture uses the same two typefaces, Space Grotesk and JetBrains Mono.
- It has been used on a handful of projects so far, by one person.
Contributing
Issues and pull requests are welcome, one change at a time. CONTRIBUTING.md has the rules.
License
MIT, see LICENSE. The two bundled fonts are under the SIL Open Font License, with their license files in skills/jano/assets.
Yorumlar (0)
Yorum birakmak icin giris yap.
Yorum birakSonuc bulunamadi