Animated Readme Image

Get your animated readme image!

Note

The server will automatically update your image every 4 hours unless there are any errors. The server will remember the last arguments that you sent and will create them.

HOW TO CREATE ONE?

1) Create a repository that will be called by your username on GitHub

In my example, it's "0mnr0" (not dsvl0)

2) Create folder "files" in this repository:

-------------------------------

3) Create "layout.html" file in new folder:

You can also place required files into that folder, for example "background.webm".

You are free to compose anything in the HTML file, there are no restrictions. It is advisable not to use any dependent "web components", work with them locally, or not add them at all. By "web components" I mean any libraries (For example, Bootstrap, Tailwind, jQuery and others that work through src="https://cdnjs.com/libraries /...")

Warning

If you adding additionals files you need to specify path to them. For example:
like this: src="background.webm"
or like this: src="https://github.com/0mnr0/0mnr0/raw/refs/heads/main/files/background.webm"

4) Creating API

"/myReadme"

Returning animated image with needed params

Name	Description	Default value	Avaiable values
person	Get layout.html from spcified GitHub person	none	Any
width	Capturing an area ?px in width	auto	>= 1
height	Capturing an area ?px in height	auto	>= 1
type	Specify you need an animated or static image	video	image | video | none
fps	(CURRENTLY DISABLED). Specify max fps for animation (MAX: 24)	24	>= 1
nocache	Disable cache to "recook" your layout file	false	true | false | none
length	length of your animation (min: 0s | max: 30s)	auto	>0 & <30 | auto
quality	Specify the quality of the output file (JPG format)	90	>= 0 & <= 100

Warning

Length = Auto
If you set "length" to "auto", the server will wait for event "ended" for all videos in your layout file and closes picture capturing.

Caution

The nocache=true parameter will redirect to the "/reameStatus?person=..." page. It is useless to use this key in the readme, it will not return the image. This option is needed to test and create your animated readme.

"/readmeStatus"

The readme status will be displayed within 30 seconds.

Name	Description	Default value	Avaiable values
person	Get current status of persons readme image	none	Any

"/myReadmeSize"

Displaying current readme size (MB and bytes).

Name	Description	Default value	Avaiable values
person	Get current readme image size	none	Any