DEV Community

Kenichiro Nakamura
Kenichiro Nakamura

Posted on

45 1

Don't waste time to write README, use readme-ai instead

As a developer, most of us (or maybe just me?) are having fun writing code, but struggling to write README.md.

But README.md is obviously one of the most important artifacts of the repository and we cannot avoid it. So what shall we do? The answer is, AI.

readme-ai

One of my colleagues let me know about "readme-ai" today which was super easy to use.

readme-ai: GitHub

They provide local several ways to run the service.

  • Locally run from the source code
  • Use pip module
  • Use docker container
  • Use the hosted web application

I found the hosted one was the easiest to use.

Streamlit app

https://readmeai.streamlit.app/

There are only two steps.

  1. Enter your Open AI API key.
  2. Enter your GitHub repository URL.

That's it!

One caveat is that you may need to use the paid version of API as you may encounter API threshold.

Summary

I believe there maybe other solutions to write README.md on our behalf, so please let me know if you know some!

API Trace View

Struggling with slow API calls? 🕒

Dan Mindru walks through how he used Sentry's new Trace View feature to shave off 22.3 seconds from an API call.

Get a practical walkthrough of how to identify bottlenecks, split tasks into multiple parallel tasks, identify slow AI model calls, and more.

Read more →

Top comments (1)

Collapse
 
ueshiman80 profile image
Masayuki Tateno

readmeai.streamlit.app/
リンク切れているみたいです

A Workflow Copilot. Tailored to You.

Pieces.app image

Our desktop app, with its intelligent copilot, streamlines coding by generating snippets, extracting code from screenshots, and accelerating problem-solving.

Read the docs

👋 Kindness is contagious

Immerse yourself in a wealth of knowledge with this piece, supported by the inclusive DEV Community—every developer, no matter where they are in their journey, is invited to contribute to our collective wisdom.

A simple “thank you” goes a long way—express your gratitude below in the comments!

Gathering insights enriches our journey on DEV and fortifies our community ties. Did you find this article valuable? Taking a moment to thank the author can have a significant impact.

Okay