OP Bento Docs

Welcome to the official documentation for OP Bento.

Hey there, GitHub superstar! Ready to give your profile some serious swagger? With OP Bento, you'll turn your profile into a dynamic, eye-catching showcase that updates automatically with your latest GitHub stats. Think of it as a mini homepage that shows the world what you’re working on, without you lifting a finger (after setup, of course)!

  • Customizable Bento Grid
  • Automatic Updates
  • Easy Setup Files
  • 1-click download
  • More features coming soon!

Get Your OP Bento!

Fill out the bio section with the information you want displayed.

OP Bento
Click on the button. And Voila !! This will generate a new Bento for you.

After you have generated your Bento

Once you have generated your Bento, you will be able to see a embed link for your Bento. You can use this link to embed your Bento on your GitHub README.md. Along with it you will also get two files are below. These are the files that you will need to setup your Bento.

Note: Do not change the name of the files. If you do, the setup will not work.

Atlast, add up the link in your README.md file and make a folder named .github/workflows and add the action.yml file in it. And in the main directory add the getNewBento.ts file. So that the setup will be look like below.

Your Repo
README.md
getNewBento.ts
.github
workflows
action.yml

Your repo settings

Dont forget to allow Write Permissions in your repo settings. This is required to update your Bento or else update-bento.yml will not update your README.

OP Bento

And That’s It! 🎉

Congrats on setting up your OP Bento! Your GitHub profile now has a unique, eye-catching grid that showcases your projects, updates with your latest activity, and is ready to impress anyone who visits. Now go forth and share it with the world! 🌍.

If you found this guide helpful, please consider giving it a star on GitHub. It helps others find it and encourages me to create more content like this. Thank you! 🙏