---
title: "Discussion on \"Github README Guide ✍️\" | Hashnode"
description: "Discussion on \"Github README Guide ✍️\". A Guide to Building Professional README Files.\nA README document is a text file that describes your project, it's the first file most developers will read when visiting your repository. It should help other developers understand your code, how to use..."
url: "https://hashnode.com/posts/github-readme-guide/61d79ae44b84101d2c3ed280"
---

[Feed](https://hashnode.com/feed) /

Discussion

# [Github README Guide ✍️](https://kaiwritescode.hashnode.dev/github-readme-guide?utm_source=hashnode&utm_medium=feed)

A Guide to Building Professional README Files. A README document is a text file that describes your project, it's the first file most developers will read when visiting your repository. It should help other developers understand your code, how to use...

Jan 7, 2022 · 6 min read · kaiwritescode.hashnode.dev  
Updated Jan 15, 2022  
Read the article

-   [#github](https://hashnode.com/tag/github)
-   [#beginners](https://hashnode.com/tag/beginners)
-   [#web-development](https://hashnode.com/tag/web-development)

## Written by

[Kai](https://hashnode.com/@KaiWritesCode)

@KaiWritesCode · United States, Florida

  
[View profile](https://hashnode.com/@KaiWritesCode)

Future Web Developer writing about React

## Responses 1

Markdown supported · ⌘↵ to post

[Cess](https://hashnode.com/@Cesscode)

[Jan 7, 2022](https://hashnode.com/posts/github-readme-guide/61d79ae44b84101d2c3ed280/comment/61d7cfda8d56921d07b8ff3b)

Thanks for sharing ❤️