Skip to content

Commit 41d5266

Browse files
authored
chore: add logo to README (#149)
1 parent 55c18f0 commit 41d5266

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Electron Docs Parser
22

3+
<img width="124" height="124" align="right" alt="docs-parser-logo" src="design/logo.png" />
4+
35
[![Test](https://github.com/electron/docs-parser/actions/workflows/test.yml/badge.svg)](https://github.com/electron/docs-parser/actions/workflows/test.yml)
46
[![npm version](http://img.shields.io/npm/v/@electron/docs-parser.svg)](https://npmjs.org/package/@electron/docs-parser)
57

@@ -16,7 +18,8 @@ electron-docs-parser --dir ./
1618
```
1719

1820
Options:
19-
* `--useReadme` - Assume all documentation is in the module's base `README.md` file
21+
22+
* `--useReadme` - Assume all documentation is in the module's base `README.md` file
2023
* `--dir` - The base directory where documentation is located.
2124
* API documentation must be located in `/docs/api` within the specified base directory.
2225
* API structures documentation must be located in `/docs/api/structures` within the specified base directory.

design/logo.png

656 KB
Loading

0 commit comments

Comments
 (0)