Esta sera una serie de 3 Post:
- Crear nuestro README en GitHub
- Escribir un script en python para crear nuestro README dinámico
- Implementar GitHub Actions para automatizar nuestro README
Acá te dejo una mirada de como quedo mi perfil, espero me dejes una estrella :D
Preparando nuestro repositorio
Para iniciar, debemos crear un repositorio en GitHub con nuestro nombre de usuario, en mi caso "rafnixg", tiene que ser publico y estar inicializado con un archivo README.
Ingresando a https://github.com/new podemos crear nuestro repositorio
En mi caso ya me indica que tengo este repositorio creado, pero ademas se ve un mensaje que nos indica que activamos esta funcionalidad "secreta"
Creando nuestro README
En esta parte del proceso tendremos que empezar clonando nuestro repositorio y editar nuestro archivo README con la información que quisiéramos mostrar, para esto usaremos el siguiente comando de Git:
$ git clone https://github.com/tu_username/tu_username.git
Luego de clonar nuestro repositorio procedemos a crear nuestro archivo README usando Markdown, yo en esta parte del proceso use varias referencias para tomar ideas y armar algo que me gustara, les dejo por acá los enlaces para que las visiten y tomen ideas.
- https://github.com/kautukkundan/Awesome-Profile-README-templates
- https://github.com/abhisheknaiidu/awesome-github-profile-readme
Ya con una idea de lo que queremos hacer, escribimos nuestro archivo y subimos estos cambios a GitHub
$ git add README.md
$ git commit -m "[IMP] Mejora de nuestro README"
$ git push -u origin master
Con esto ya tendremos nuestro archivo README desplegado en nuestro perfil de GitHub.
En la segunda entrega veremos como poder obtener datos de una API como la Ghost o Dev.to y actualizar nuestro archivo README usando Python.
Gracias por leerme! los espero por mi twitter @rafnixg
Top comments (0)