Accessibility Report
Report Date: April 18, 2025
ReadMe runs daily automated tests against the WCAG 2.1 AA standard using the axe-core library. As of this report there are no reported issues. In addition to the automated tests, ReadMe also uses a third-party to manually audit for issues and the results of both are covered by this report.
| Covered | Standard |
|---|---|
| Automated Tests (axe-core) | WCAG 2.1 AA |
| Manual Tests | WCAG 2.1 AA |
Conformance Levels
- Compliant: The criterion is met without known defects or meets with equivalent facilitation.
- Partial Compliance: Some functionality does not meet the criterion.
- Not Compliant: The majority of functionality does not meet the criterion.
- Not Applicable: The criterion is not relevant.
WCAG 2.1 Report
Table 1: Level A
| Criteria | Conformance | Comment |
|---|---|---|
| 1.1.1 Non-text Content (Level A) All non-text content that is presented to the user has a text alternative that serves the equivalent purpose, except for the situations listed below.
| Compliant | |
| 1.2.1 Audio-only and Video-only (Prerecorded) (Level A) For prerecorded audio-only and prerecorded video-only media, the following are true, except when the audio or video is a media alternative for text and is clearly labeled as such:
| Not Applicable | While ReadMe can display prerecorded audio-only and video-only media, ReadMe does not provide the source material or alternative media. |
| 1.2.2 Captions (Prerecorded) (Level A) Captions are provided for all prerecorded audio content in synchronized media, except when the media is a media alternative for text and is clearly labeled as such. | Not Applicable | While ReadMe can display captioned media, ReadMe does not provide the source material or captions. |
| 1.2.3 Audio Description or Media Alternative (Prerecorded) (Level A) Captions are provided for all live audio content in synchronized media. | Not Applicable | While ReadMe can display captioned media, ReadMe does not provide the source material or captions. |
| 1.3.1 Info and Relationships (Level A) Information, structure, and relationships conveyed through presentation can be programmatically determined or are available in text. | Partial Compliance | Most information, structure, and relationship information is compliant. Exception:
|
| 1.3.2 Meaningful Sequence (Level A) When the sequence in which content is presented affects its meaning, a correct reading sequence can be programmatically determined. | Compliant | |
| 1.3.3 Sensory Characteristics (Level A) Instructions provided for understanding and operating content do not rely solely on sensory characteristics of components such as shape, color, size, visual location, orientation, or sound.Note: For requirements related to color, refer to Guideline 1.4. | Compliant | |
| 1.4.1 Use of Color (Level A) Color is not used as the only visual means of conveying information, indicating an action, prompting a response, or distinguishing a visual element.Note: This success criterion addresses color perception specifically. Other forms of perception are covered in Guideline 1.3 including programmatic access to color and other visual presentation coding | Compliant | |
| 1.4.2 Audio Control (Level A) If any audio on a Web page plays automatically for more than 3 seconds, either a mechanism is available to pause or stop the audio, or a mechanism is available to control audio volume independently from the overall system volume level.Note: Since any content that does not meet this success criterion can interfere with a user's ability to use the whole page, all content on the Web page (whether or not it is used to meet other success criteria) must meet this success criterion. See Conformance Requirement 5: Non-Interference. | Not Applicable | While ReadMe can play audio, ReadMe does not control the source audio behavior. |
| 2.1.1 Keyboard (Level A) All functionality of the content is operable through a keyboard interface without requiring specific timings for individual keystrokes, except where the underlying function requires input that depends on the path of the user's movement and not just the endpoints.Note 1: This exception relates to the underlying function, not the input technique. For example, if using handwriting to enter text, the input technique (handwriting) requires path-dependent input but the underlying function (text input) does not.Note 2: This does not forbid and should not discourage providing mouse input or other input methods in addition to keyboard operation. | Compliant | |
| 2.1.2 No Keyboard Trap (Level A) If keyboard focus can be moved to a component of the page using a keyboard interface, then focus can be moved away from that component using only a keyboard interface, and, if it requires more than unmodified arrow or tab keys or other standard exit methods, the user is advised of the method for moving focus away.Note: Since any content that does not meet this success criterion can interfere with a user's ability to use the whole page, all content on the Web page (whether it is used to meet other success criteria or not) must meet this success criterion. See Conformance Requirement 5: Non-Interference. | Partial Compliance | Most components that are keyboard accessible can use a standard exit method. Exception:
|
| 2.1.4 Character Key Shortcuts (Level A 2.1 only) If a keyboard shortcut is implemented in content using only letter (including upper- and lower-case letters), punctuation, number, or symbol characters, then at least one of the following is true:
| Not Applicable | |
| 2.2.1 Timing Adjustable (Level A) For each time limit that is set by the content, at least one of the following is true:
| Not Applicable | |
2.2.2 Pause, Stop, Hide: For moving, blinking, scrolling, or auto-updating information, all of the following are true: (Level A)
Note 3: Content that is updated periodically by software or that is streamed to the user agent is not required to preserve or present information that is generated or received between the initiation of the pause and resuming presentation, as this may not be technically possible, and in many situations could be misleading to do so. Note 4: An animation that occurs as part of a preload phase or similar situation can be considered essential if interaction cannot occur during that phase for all users and if not indicating progress could confuse users or cause them to think that content was frozen or broken. | Not Applicable | |
| 2.3.1 Three Flashes or Below Threshold (Level A) Web pages do not contain anything that flashes more than three times in any one second period, or the flash is below the general flash and red flash thresholds. Note: Since any content that does not meet this success criterion can interfere with a user's ability to use the whole page, all content on the Web page (whether it is used to meet other success criteria or not) must meet this success criterion. See Conformance Requirement 5: Non-Interference. | Not Applicable | |
| 2.4.1 Bypass Blocks (Level A) A mechanism is available to bypass blocks of content that are repeated on multiple Web pages. | Partial Compliance | A link to skip pages’ headers and navigation is provided as the first element in focus order. Exception:
|
| 2.4.2 Page Titled (Level A) Web pages have titles that describe topic or purpose. | Compliant | |
| 2.4.3 Focus Order (Level A) If a Web page can be navigated sequentially and the navigation sequences affect meaning or operation, focusable components receive focus in an order that preserves meaning and operability. | Compliant | |
| 2.4.4 Link Purpose (In Context) (Level A) The purpose of each link can be determined from the link text alone or from the link text together with its programmatically determined link context, except where the purpose of the link would be ambiguous to users in general. | Compliant | |
| 2.5.1 Pointer Gestures (Level A 2.1 only) All functionality that uses multipoint or path-based gestures for operation can be operated with a single pointer without a path-based gesture, unless a multipoint or path-based gesture is essential. | Not Applicable | |
| 2.5.2 Pointer Cancellation (Level A 2.1 only) For functionality that can be operated using a single pointer, at least one of the following is true:
| Compliant | |
| 2.5.3 Label in Name (Level A 2.1 only) For user interface components with labels that include text or images of text, the name contains the text that is presented visually. | Compliant | |
| 2.5.4 Motion Actuation (Level A 2.1 only) Functionality that can be operated by device motion or user motion can also be operated by user interface components and responding to the motion can be disabled to prevent accidental actuation, except when:
| Not Applicable | |
| 3.1.1 Language of Page (Level A) The default human language of each Web page can be programmatically determined. | Compliant | |
| 3.2.1 On Focus (Level A) When any user interface component receives focus, it does not initiate a change of context. | Compliant | |
| 3.2.2 On Input (Level A) Changing the setting of any user interface component does not automatically cause a change of context unless the user has been advised of the behavior before using the component. | Compliant | |
| 3.3.1 Error Identification (Level A) If an input error is automatically detected, the item that is in error is identified and the error is described to the user in text. | Compliant | |
| 3.3.2 Labels or Instructions (Level A) Labels or instructions are provided when content requires user input. | Compliant | |
| 4.1.1 Parsing (Level A) In content implemented using markup languages, elements have complete start and end tags, elements are nested according to their specifications, elements do not contain duplicate attributes, and any IDs are unique, except where the specifications allow these features. Note: Start and end tags that are missing a critical character in their formation, such as a closing angle bracket or a mismatched attribute value quotation mark are not complete. | Compliant | |
| 4.1.2 Name, Role, Value (Level A) For all user interface components (including but not limited to: form elements, links and components generated by scripts), the name and role can be programmatically determined; states, properties, and values that can be set by the user can be programmatically set; and notification of changes to these items is available to user agents, including assistive technologies. Note: This success criterion is primarily for Web authors who develop or script their own user interface components. For example, standard HTML controls already meet this success criterion when used according to specification. | Compliant |
Table 2: Level AA
| Criteria | Conformance | Comment |
|---|---|---|
| 1.2.4 Captions (Live) (Level AA) Captions are provided for all live audio content in synchronized media. | Not Applicable | While ReadMe can play audio media, ReadMe does not provide the source material or captions. |
| 1.2.5 Audio Description (Prerecorded) (Level AA) Audio description is provided for all prerecorded video content in synchronized media. | Not Applicable | While ReadMe can play audio media, ReadMe does not provide the source material or descriptions. |
| 1.3.4 Orientation (Level AA 2.1 only) Content does not restrict its view and operation to a single display orientation, such as portrait or landscape, unless a specific display orientation is essential. | Compliant | |
| 1.3.5 Identify Input Purpose (Level AA 2.1 only) The purpose of each input field collecting information about the user can be programmatically determined when:
| Compliant | |
| 1.4.3 Contrast (Minimum) (Level AA) The visual presentation of text and images of text has a contrast ratio of at least 4.5:1, except for the following:
| Partial Compliance | Most text in ReadMe meets minimum contrast requirements. Exceptions:
|
| 1.4.4 Resize text (Level AA) Except for captions and images of text, text can be resized without assistive technology up to 200 percent without loss of content or functionality. | Compliant | |
| 1.4.5 Images of Text (Level AA) If the technologies being used can achieve the visual presentation, text is used to convey information rather than images of text except for the following:
| Compliant | |
| 1.4.10 Reflow (Level AA 2.1 only) Content can be presented without loss of information or functionality, and without requiring scrolling in two dimensions for:
| Compliant | |
| 1.4.11 Non-text Contrast (Level AA 2.1 only) The visual presentation of the following have a contrast ratio of at least 3:1 against adjacent color(s):
| Compliant | |
| 1.4.12 Text Spacing (Level AA 2.1 only) In content implemented using markup languages that support the following text style properties, no loss of content or functionality occurs by setting all of the following and by changing no other style property:
| Compliant | |
| 1.4.13 Content on Hover or Focus (Level AA 2.1 only) Where receiving and then removing pointer hover or keyboard focus triggers additional content to become visible and then hidden, the following are true:
| Compliant | |
| 2.4.5 Multiple Ways (Level AA) More than one way is available to locate a Web page within a set of Web pages except where the Web Page is the result of, or a step in, a process. | Compliant | |
| 2.4.6 Headings and Labels (Level AA) Headings and labels describe topic or purpose. | Compliant | |
| 2.4.7 Focus Visible (Level AA) Any keyboard operable user interface has a mode of operation where the keyboard focus indicator is visible. | Compliant | |
| 3.1.2 Language of Parts (Level AA) The human language of each passage or phrase in the content can be programmatically determined except for proper names, technical terms, words of indeterminate language, and words or phrases that have become part of the vernacular of the immediately surrounding text. | Compliant | |
| 3.2.3 Consistent Navigation (Level AA) Navigational mechanisms that are repeated on multiple Web pages within a set of Web pages occur in the same relative order each time they are repeated, unless a change is initiated by the user. | Compliant | |
| 3.2.4 Consistent Identification (Level AA) Components that have the same functionality within a set of Web pages are identified consistently. | Compliant | |
| 3.3.3 Error Suggestion (Level AA) If an input error is automatically detected and suggestions for correction are known, then the suggestions are provided to the user, unless it would jeopardize the security or purpose of the content. | Compliant | |
| 3.3.4 Error Prevention (Legal, Financial, Data) (Level AA) For Web pages that cause legal commitments or financial transactions for the user to occur, that modify or delete user-controllable data in data storage systems, or that submit user test responses, at least one of the following is true:
| Compliant | |
| 4.1.3 Status Messages (Level AA 2.1 only) In content implemented using markup languages, status messages can be programmatically determined through role or properties such that they can be presented to the user by assistive technologies without receiving focus. | Compliant |
Updates
3/11/2026:
- Dark mode Changelog links are now in compliance (1.4.1).
- Required labels in API Reference are now in compliance (1.4.3).
5/6/2025: Added note on API Reference: Code syntax highlighter to 1.4.3
Updated about 1 month ago