README with a quick start

A step of the Open source library tree on Gradus, in the Project hygiene area: License, README, docs.

Write a README that shows the install command and a working example in the first screen, then the API in brief.

Usually comes after: License file.

Leads to: Contributing guide, API reference.

Prompt for your AI assistant

Write a README.md for this library: a one-paragraph description, the install command, a minimal example that runs as written, a short section on the main API and links to the license and contributing guide. Keep the quick start above the fold.

This is https://gradus.kazet.blog/tree/open-source-library/step/readme as plain HTML. In a browser the page also lets you mark the step forged and copy a message for your AI assistant.