Skip to content

Tool to create the README file of my Github page dynamically.

License

Notifications You must be signed in to change notification settings

Qkessler/Qkessler-README

Repository files navigation

Qkessler-README

Go project to dynamically generate the contents of the README of my github profile. The way we fill the Github content is by pulling Github API, and then composing the different UI elements by chunking and joining the resulting repos ordered by the last time that there was a push.

Developing

If you want to use this or contribute, you can get the Go project by cloning this repo:

git clone https://github.com/Qkessler/Qkessler-README

and 

go build -o generate-readme

and then inspecting the ./readme.sh file, that contains information on how to set the GH_ACCESS_TOKEN environment variable, that contains the access token to Github API. I personally use pass to manage my passwords, and if you do too, you can just add an entry called gh-access-token.

After that, you should be able to run the ./readme.sh file, but will be generating the readme dynamically for the Qkessler submodule included in the repo. You can change that and rerun ./readme.sh.

Example generated README

You can visit my main Qkessler page on Github to see an example of the generated README at all times, but you can also find the content below:


Hi there! I'm Quique, and I'm currently working as a SDE at Amazon. I'm part of the Notifications team on the Kindle organization, and I work on bringing notifications to customers on different surfaces: iOS, Android and FireOS. On my free time, I like reading, hiking, plants, cats and Open Source Software. Here's my web: enriquekesslerm.com, where you'll find posts about any of those.

Below you'll find a featured repo, which is one of my 10th last updated. Below the repo card, you'll find an ordered list of my repositories and their languages, which shows the languages that I work with the most, and the ones I have been working with as of late, for my personal projects.

About

Tool to create the README file of my Github page dynamically.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages