{"id":1040,"date":"2026-02-05T10:46:12","date_gmt":"2026-02-05T09:46:12","guid":{"rendered":"https:\/\/vermiip.es\/blog\/?p=1040"},"modified":"2026-02-05T10:46:14","modified_gmt":"2026-02-05T09:46:14","slug":"como-documentar-un-proyecto-en-github-con-readme-md","status":"publish","type":"post","link":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/","title":{"rendered":"C\u00f3mo documentar un proyecto en GitHub con README.md"},"content":{"rendered":"<p>El archivo <code>README.md<\/code> es fundamental para cualquier proyecto que se aloje en GitHub. No solo sirve como la carta de presentaci\u00f3n del repositorio, sino que tambi\u00e9n proporciona informaci\u00f3n esencial sobre el uso, la instalaci\u00f3n y la contribuci\u00f3n al c\u00f3digo. En este art\u00edculo, exploraremos c\u00f3mo crear un <code>README.md<\/code> efectivo que mejore la comprensi\u00f3n y la colaboraci\u00f3n en tu proyecto.<\/p>\n<h2>Qu\u00e9 es un README.md<\/h2>\n<p>El <code>README.md<\/code> es un archivo escrito en Markdown que se encuentra en la ra\u00edz del repositorio y se utiliza para documentar el prop\u00f3sito y uso del proyecto. Markdown es un lenguaje de marcado ligero que permite formatear texto de manera sencilla y eficaz.<\/p>\n<h2>Por qu\u00e9 es importante tener un buen README.md<\/h2>\n<p>Un buen <code>README.md<\/code> proporciona varias ventajas:<\/p>\n<ul>\n<li><strong>Facilita la colaboraci\u00f3n:<\/strong> Ayuda a otros a comprender r\u00e1pidamente c\u00f3mo contribuir al proyecto.<\/li>\n<li><strong>Mejora la visibilidad:<\/strong> Un archivo bien estructurado puede atraer a m\u00e1s usuarios y colaboradores.<\/li>\n<li><strong>Reduce consultas:<\/strong> Responde preguntas frecuentes y proporciona informaci\u00f3n b\u00e1sica, evitando que los usuarios tengan que contactar a los mantenedores.<\/li>\n<\/ul>\n<h2>Estructura b\u00e1sica de un README.md<\/h2>\n<p>La siguiente es una estructura b\u00e1sica recomendada que puedes seguir para crear tu <code>README.md<\/code>:<\/p>\n<ol>\n<li><strong>T\u00edtulo<\/strong><\/li>\n<li><strong>Descripci\u00f3n del proyecto<\/strong><\/li>\n<li><strong>Instalaci\u00f3n<\/strong><\/li>\n<li><strong>Uso<\/strong><\/li>\n<li><strong>Contribuciones<\/strong><\/li>\n<li><strong>Licencia<\/strong><\/li>\n<\/ol>\n<h2>C\u00f3mo crear cada secci\u00f3n del README.md<\/h2>\n<h3>T\u00edtulo<\/h3>\n<p>Empieza con el nombre del proyecto en un tama\u00f1o de fuente grande:<\/p>\n<pre><code># Nombre del Proyecto<\/code><\/pre>\n<h3>Descripci\u00f3n del proyecto<\/h3>\n<p>A continuaci\u00f3n, proporciona una breve descripci\u00f3n del proyecto. Explica su objetivo, caracter\u00edsticas principales y cualquier contexto relevante.<\/p>\n<pre><code>Este proyecto tiene como objetivo...<\/code><\/pre>\n<h3>Instalaci\u00f3n<\/h3>\n<p>Incluir instrucciones claras sobre c\u00f3mo instalar el proyecto es crucial. Si has usado <a href=\"https:\/\/vermiip.es\/blog\/como-instalar-node-js-en-windows\/\">Node.js<\/a>, por ejemplo, podr\u00edas incluir:<\/p>\n<pre><code>git clone https:\/\/github.com\/usuario\/nombre-del-proyecto.git\ncd nombre-del-proyecto\nnpm install<\/code><\/pre>\n<h3>Uso<\/h3>\n<p>Proporciona ejemplos de uso claros, idealmente con fragmentos de c\u00f3digo. Un ejemplo sencillo podr\u00eda ser:<\/p>\n<pre><code>const proyecto = require('nombre-del-proyecto');\nproyecto.funcionEjemplo();<\/code><\/pre>\n<h3>Contribuciones<\/h3>\n<p>Si deseas que otros contribuyan a tu proyecto, especifica el proceso para enviar pull requests. Por ejemplo:<\/p>\n<pre><code>1. Haz un fork del repositorio\n2. Crea una nueva rama (<strong>git checkout -b nueva-rama<\/strong>)\n3. Realiza cambios y haz un commit (<strong>git commit -m 'Descripci\u00f3n de los cambios'<\/strong>)\n4. Env\u00eda un push a tu fork (<strong>git push origin nueva-rama<\/strong>)\n5. Abre un pull request<\/code><\/pre>\n<h3>Licencia<\/h3>\n<p>Finalmente, indica bajo qu\u00e9 licencia se distribuye tu proyecto. Si no est\u00e1s seguro, <a href=\"https:\/\/opensource.org\/licenses\">Open Source Initiative<\/a> ofrece una buena referencia.<\/p>\n<pre><code>Este proyecto est\u00e1 licenciado bajo la licencia MIT.<\/code><\/pre>\n<h2>Mejores pr\u00e1cticas para un README.md efectivo<\/h2>\n<p>Aparte de la estructura b\u00e1sica, aqu\u00ed hay algunas mejores pr\u00e1cticas a seguir:<\/p>\n<ul>\n<li><strong>Usa un lenguaje claro y conciso:<\/strong> Evita jergas t\u00e9cnicas innecesarias.<\/li>\n<li><strong>Incluye im\u00e1genes o GIFs:<\/strong> A veces, una imagen vale m\u00e1s que mil palabras.<\/li>\n<li><strong>Mant\u00e9n actualizado el README.md:<\/strong> Aseg\u00farate de que la informaci\u00f3n est\u00e9 siempre vigente.<\/li>\n<\/ul>\n<h2>Conclusi\u00f3n<\/h2>\n<p>Documentar correctamente un proyecto en GitHub mediante un archivo <code>README.md<\/code> no es solo una buena pr\u00e1ctica, sino una necesidad para cualquier desarrollador que quiera que su trabajo sea aprovechado y entendido por otros. Siguiendo la estructura y las recomendaciones compartidas, podr\u00e1s crear un recurso valioso que mejore la comprensi\u00f3n y la colaboraci\u00f3n en tu proyecto.<\/p>\n<h3>Fuentes y lecturas recomendadas<\/h3>\n<ul>\n<li><a href=\"https:\/\/opensource.com\/article\/19\/11\/how-write-readme\">C\u00f3mo escribir un README<\/a><\/li>\n<li><a href=\"https:\/\/www.codementor.io\/@oluwasijibomi\/how-to-create-a-great-readme-for-your-project-1qnfq71k39\">Mejoras para tu README.md<\/a><\/li>\n<li><a href=\"https:\/\/www.git-tower.com\/learn\/git\/ebook\/en\/command-line\/appendix\/markdown\">Introducci\u00f3n a Markdown<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>El archivo README.md es fundamental para cualquier proyecto que se aloje en GitHub. No solo sirve como la carta de presentaci\u00f3n del repositorio, sino que tambi\u00e9n proporciona informaci\u00f3n esencial sobre el uso, la instalaci\u00f3n y la contribuci\u00f3n al c\u00f3digo. En este art\u00edculo, exploraremos c\u00f3mo crear un README.md efectivo que mejore la comprensi\u00f3n y la colaboraci\u00f3n en tu proyecto.<\/p>\n","protected":false},"author":1,"featured_media":1041,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[180],"tags":[229,237],"class_list":["post-1040","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-git","tag-github","tag-readme-md"],"_wp_attached_file":null,"_wp_attachment_metadata":null,"_wp_old_slug":null,"_aioseop_description":null,"_wp_attachment_image_alt":null,"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.4 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>C\u00f3mo documentar un proyecto en GitHub con README.md - Ver mi IP<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/\" \/>\n<meta property=\"og:locale\" content=\"es_ES\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"C\u00f3mo documentar un proyecto en GitHub con README.md - Ver mi IP\" \/>\n<meta property=\"og:description\" content=\"El archivo README.md es fundamental para cualquier proyecto que se aloje en GitHub. No solo sirve como la carta de presentaci\u00f3n del repositorio, sino que tambi\u00e9n proporciona informaci\u00f3n esencial sobre el uso, la instalaci\u00f3n y la contribuci\u00f3n al c\u00f3digo. En este art\u00edculo, exploraremos c\u00f3mo crear un README.md efectivo que mejore la comprensi\u00f3n y la colaboraci\u00f3n en tu proyecto.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/\" \/>\n<meta property=\"og:site_name\" content=\"Ver mi IP\" \/>\n<meta property=\"article:published_time\" content=\"2026-02-05T09:46:12+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2026-02-05T09:46:14+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/vermiip.es\/blog\/wp-content\/uploads\/2026\/02\/output1-1.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1792\" \/>\n\t<meta property=\"og:image:height\" content=\"1024\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Xose de la Paz\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Escrito por\" \/>\n\t<meta name=\"twitter:data1\" content=\"Xose de la Paz\" \/>\n\t<meta name=\"twitter:label2\" content=\"Tiempo de lectura\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutos\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/\"},\"author\":{\"name\":\"Xose de la Paz\",\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/#\\\/schema\\\/person\\\/0617918e61a75dc2d11c09238bf84200\"},\"headline\":\"C\u00f3mo documentar un proyecto en GitHub con README.md\",\"datePublished\":\"2026-02-05T09:46:12+00:00\",\"dateModified\":\"2026-02-05T09:46:14+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/\"},\"wordCount\":494,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/#organization\"},\"image\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/wp-content\\\/uploads\\\/2026\\\/02\\\/output1-1.png\",\"keywords\":[\"Github\",\"README.md\"],\"articleSection\":[\"GIT\"],\"inLanguage\":\"es\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/\",\"url\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/\",\"name\":\"C\u00f3mo documentar un proyecto en GitHub con README.md - Ver mi IP\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/wp-content\\\/uploads\\\/2026\\\/02\\\/output1-1.png\",\"datePublished\":\"2026-02-05T09:46:12+00:00\",\"dateModified\":\"2026-02-05T09:46:14+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/#breadcrumb\"},\"inLanguage\":\"es\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"es\",\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/#primaryimage\",\"url\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/wp-content\\\/uploads\\\/2026\\\/02\\\/output1-1.png\",\"contentUrl\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/wp-content\\\/uploads\\\/2026\\\/02\\\/output1-1.png\",\"width\":1792,\"height\":1024,\"caption\":\"C\u00f3mo documentar un proyecto en GitHub con README.md\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/como-documentar-un-proyecto-en-github-con-readme-md\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Portada\",\"item\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"C\u00f3mo documentar un proyecto en GitHub con README.md\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/#website\",\"url\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/\",\"name\":\"Cual es mi ip - Internet y otras locuras\",\"description\":\"Internet y otras locuras\",\"publisher\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/#organization\"},\"alternateName\":\"Cual es mi IP\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"es\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/#organization\",\"name\":\"Ver mi IP\",\"alternateName\":\"vermiip\",\"url\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"es\",\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/10\\\/cropped-logo-vermiip-naranja.png\",\"contentUrl\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/wp-content\\\/uploads\\\/2023\\\/10\\\/cropped-logo-vermiip-naranja.png\",\"width\":512,\"height\":512,\"caption\":\"Ver mi IP\"},\"image\":{\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/#\\\/schema\\\/logo\\\/image\\\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/vermiip.es\\\/blog\\\/#\\\/schema\\\/person\\\/0617918e61a75dc2d11c09238bf84200\",\"name\":\"Xose de la Paz\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"es\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d248b555dd18abd5e7350d28ecf07116718da621eb85762e02558c2cef2bb8bc?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d248b555dd18abd5e7350d28ecf07116718da621eb85762e02558c2cef2bb8bc?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/d248b555dd18abd5e7350d28ecf07116718da621eb85762e02558c2cef2bb8bc?s=96&d=mm&r=g\",\"caption\":\"Xose de la Paz\"},\"description\":\"M\u00e1s de 20 a\u00f1os transformando pasi\u00f3n en profesi\u00f3n. Experto en desarrollo Full Stack con una visi\u00f3n integral que abarca desde la gesti\u00f3n de servidores y redes hasta el dise\u00f1o de interfaz. Soy un \\\"todoterreno\\\" tecnol\u00f3gico que cree en el aprendizaje continuo y la visi\u00f3n global de los proyectos. Entre despliegue y despliegue, me pierdo por el mundo con mi c\u00e1mara al hombro.\",\"sameAs\":[\"https:\\\/\\\/www.enfocado.com\",\"https:\\\/\\\/www.instagram.com\\\/xose_de_la_paz\\\/\",\"https:\\\/\\\/www.linkedin.com\\\/in\\\/xosedelapaz\\\/\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"C\u00f3mo documentar un proyecto en GitHub con README.md - Ver mi IP","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/","og_locale":"es_ES","og_type":"article","og_title":"C\u00f3mo documentar un proyecto en GitHub con README.md - Ver mi IP","og_description":"El archivo README.md es fundamental para cualquier proyecto que se aloje en GitHub. No solo sirve como la carta de presentaci\u00f3n del repositorio, sino que tambi\u00e9n proporciona informaci\u00f3n esencial sobre el uso, la instalaci\u00f3n y la contribuci\u00f3n al c\u00f3digo. En este art\u00edculo, exploraremos c\u00f3mo crear un README.md efectivo que mejore la comprensi\u00f3n y la colaboraci\u00f3n en tu proyecto.","og_url":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/","og_site_name":"Ver mi IP","article_published_time":"2026-02-05T09:46:12+00:00","article_modified_time":"2026-02-05T09:46:14+00:00","og_image":[{"width":1792,"height":1024,"url":"https:\/\/vermiip.es\/blog\/wp-content\/uploads\/2026\/02\/output1-1.png","type":"image\/png"}],"author":"Xose de la Paz","twitter_card":"summary_large_image","twitter_misc":{"Escrito por":"Xose de la Paz","Tiempo de lectura":"3 minutos"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/#article","isPartOf":{"@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/"},"author":{"name":"Xose de la Paz","@id":"https:\/\/vermiip.es\/blog\/#\/schema\/person\/0617918e61a75dc2d11c09238bf84200"},"headline":"C\u00f3mo documentar un proyecto en GitHub con README.md","datePublished":"2026-02-05T09:46:12+00:00","dateModified":"2026-02-05T09:46:14+00:00","mainEntityOfPage":{"@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/"},"wordCount":494,"commentCount":0,"publisher":{"@id":"https:\/\/vermiip.es\/blog\/#organization"},"image":{"@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/#primaryimage"},"thumbnailUrl":"https:\/\/vermiip.es\/blog\/wp-content\/uploads\/2026\/02\/output1-1.png","keywords":["Github","README.md"],"articleSection":["GIT"],"inLanguage":"es","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/","url":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/","name":"C\u00f3mo documentar un proyecto en GitHub con README.md - Ver mi IP","isPartOf":{"@id":"https:\/\/vermiip.es\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/#primaryimage"},"image":{"@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/#primaryimage"},"thumbnailUrl":"https:\/\/vermiip.es\/blog\/wp-content\/uploads\/2026\/02\/output1-1.png","datePublished":"2026-02-05T09:46:12+00:00","dateModified":"2026-02-05T09:46:14+00:00","breadcrumb":{"@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/#breadcrumb"},"inLanguage":"es","potentialAction":[{"@type":"ReadAction","target":["https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/"]}]},{"@type":"ImageObject","inLanguage":"es","@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/#primaryimage","url":"https:\/\/vermiip.es\/blog\/wp-content\/uploads\/2026\/02\/output1-1.png","contentUrl":"https:\/\/vermiip.es\/blog\/wp-content\/uploads\/2026\/02\/output1-1.png","width":1792,"height":1024,"caption":"C\u00f3mo documentar un proyecto en GitHub con README.md"},{"@type":"BreadcrumbList","@id":"https:\/\/vermiip.es\/blog\/como-documentar-un-proyecto-en-github-con-readme-md\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Portada","item":"https:\/\/vermiip.es\/blog\/"},{"@type":"ListItem","position":2,"name":"C\u00f3mo documentar un proyecto en GitHub con README.md"}]},{"@type":"WebSite","@id":"https:\/\/vermiip.es\/blog\/#website","url":"https:\/\/vermiip.es\/blog\/","name":"Cual es mi ip - Internet y otras locuras","description":"Internet y otras locuras","publisher":{"@id":"https:\/\/vermiip.es\/blog\/#organization"},"alternateName":"Cual es mi IP","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/vermiip.es\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"es"},{"@type":"Organization","@id":"https:\/\/vermiip.es\/blog\/#organization","name":"Ver mi IP","alternateName":"vermiip","url":"https:\/\/vermiip.es\/blog\/","logo":{"@type":"ImageObject","inLanguage":"es","@id":"https:\/\/vermiip.es\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/vermiip.es\/blog\/wp-content\/uploads\/2023\/10\/cropped-logo-vermiip-naranja.png","contentUrl":"https:\/\/vermiip.es\/blog\/wp-content\/uploads\/2023\/10\/cropped-logo-vermiip-naranja.png","width":512,"height":512,"caption":"Ver mi IP"},"image":{"@id":"https:\/\/vermiip.es\/blog\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/vermiip.es\/blog\/#\/schema\/person\/0617918e61a75dc2d11c09238bf84200","name":"Xose de la Paz","image":{"@type":"ImageObject","inLanguage":"es","@id":"https:\/\/secure.gravatar.com\/avatar\/d248b555dd18abd5e7350d28ecf07116718da621eb85762e02558c2cef2bb8bc?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/d248b555dd18abd5e7350d28ecf07116718da621eb85762e02558c2cef2bb8bc?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d248b555dd18abd5e7350d28ecf07116718da621eb85762e02558c2cef2bb8bc?s=96&d=mm&r=g","caption":"Xose de la Paz"},"description":"M\u00e1s de 20 a\u00f1os transformando pasi\u00f3n en profesi\u00f3n. Experto en desarrollo Full Stack con una visi\u00f3n integral que abarca desde la gesti\u00f3n de servidores y redes hasta el dise\u00f1o de interfaz. Soy un \"todoterreno\" tecnol\u00f3gico que cree en el aprendizaje continuo y la visi\u00f3n global de los proyectos. Entre despliegue y despliegue, me pierdo por el mundo con mi c\u00e1mara al hombro.","sameAs":["https:\/\/www.enfocado.com","https:\/\/www.instagram.com\/xose_de_la_paz\/","https:\/\/www.linkedin.com\/in\/xosedelapaz\/"]}]}},"_links":{"self":[{"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/posts\/1040","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/comments?post=1040"}],"version-history":[{"count":1,"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/posts\/1040\/revisions"}],"predecessor-version":[{"id":1042,"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/posts\/1040\/revisions\/1042"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/media\/1041"}],"wp:attachment":[{"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/media?parent=1040"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/categories?post=1040"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/vermiip.es\/blog\/wp-json\/wp\/v2\/tags?post=1040"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}