July 13, 2026 — by Lulu Liu in Uncategorized
Reading the README for React
In my last post, I reviewed the AI Now Institute as an example of public-facing policy writing. This week, I would like to go back to the discipline itself. As a CS student, one of the genres I encounter most frequently is the README file. I have written about this genre before in my own projects, and this time I will analyze a professional example: the README for React, Facebook’s open-source JavaScript library for building user interfaces. What makes React’s README worth analyzing is how deliberately it plays with structure, tone, imagery, and language to make them work together to serve a specific audience and accomplish a list of goals.
Image via Engineering at Meta
Content and Author
React’s README was authored and is maintained by Meta, the company that built React for internal usage before open-sourcing it in 2013. The document mainly communicates three things: what React is, how to start using it, and how to contribute to it. The README opens with a one-sentence definition: “React is a JavaScript library for building user interfaces”. It then immediately expands into three bolded bullet points explaining its philosophy: declarative, component-based, and learn once, write anywhere. Every word in the document goes straight to the point. It does not go on and on about its background and history, nor announcements like “we are excited to present.” It assumes the user already decided they want to know what React is, and that is indeed the case.
Images and Symbols
At first glance, React’s README appears to include no images; only plain text, code, and links. But embedded in the title are five badges: a license badge, an npm version badge, two build status badges, and a “PR’s welcome” badge. These small and unnoticeable icons do the rhetorical work. The license badge tells a developer the project is MIT licensed, meaning it is free to use commercially. The build status badges show that the code is currently passing tests. The “PRs Welcome” badge symbolizes the openness of the community. None of these is written out directly; it is communicated in a simple visual format that most developers would instantly be able to read. For this technical audience, badges are a shorthand credibility system.
Audience and Purpose
React’s README serves many distinct audience groups at different skill levels. The curious newcomer interested in React is served by the opening statements and bullet points; the developer ready to install React is served by the Installation guide sections; the potential contributor is served by the Contributing section, which also links to a Code of Conduct, a guide, and beginner-friendly issues. This single document serves all three audiences without making any of them go through irrelevant information. README files in processional CS contexts are expected to be concise and skimmable, and React was able to execute this perfectly.
Form and Tone
The form of this README is classic Markdown style: headers, bullet points, inline code blocks, and hyperlinks. No long paragraphs, no transitions, no narratives. The tone is logical and professional with a touch of warmth. Phrases like “to help you get your feet wet” show React’s approachability by sacrificing their authority. They also included a short section of working code. The purpose of that is to show you what React code looks like and make it feel accessible before you have to dive into the sea of confusing codes. This is a sign of helpfulness disguised as cold documentation.
Rhetorical Appeals
React’s README mainly relies on logos and ethos. The logos shows up in its basic structure, in how every claim is backed up by a link or demonstration. The ethos is established through the badges, the Meta authorship, the MIT license, and the transparency of putting itself up for public development on GitHub. There is minimal pathos, which is appropriate for this genre. The one exception is the “PR’s Welcome” badge, which is a signal that this community wants you, which is meaningful for a highly-technical open source like this that may feel intimidating to newcomers.
Analysis
What React’s README reveals about the genre is that a README is never simply just documentation. It leaves a first impression, a credibility statement, and a recruitment tool simultaneously. Developers are spoiled with many options, and there are thousands of JavaScript libraries competing for their attention. React’s README earns trust in the first few seconds through its badges, earns interest through its philosophy summary, and earns commitment through its documentation links. Oftentimes in CS writing, brevity is credibility. A README that over-explains and fluffs its text does not trust its reader, and it is obvious that React’s README trusts its reader. Genre conventions in CS are the infrastructure and foundation through which technical knowledge moves through communities.
Leave a Reply