Skip to content

Commit bf220a4

Browse files
committed
more docs
1 parent 07a9b5f commit bf220a4

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ User programmable screen overlay using web technologies
99
<a href="https://github.com/sponsors/progrium" title="Sponsor Project"><img src="https://img.shields.io/static/v1?label=sponsor&message=%E2%9D%A4&logo=GitHub" alt="Sponsor Project" /></a>
1010

1111
---
12-
* Display information or always-on-top widgets
12+
* Display information and always-on-top widgets
1313
* Use HTML/JS/CSS to draw on your screen
1414
* Great for screencasting or streaming overlays
1515
* Edit source, hit save, screen will update
@@ -61,17 +61,19 @@ in the right place before generating, or modify the plist file.
6161

6262
## Documentation
6363

64-
* wiki
64+
There is not a whole lot to topframe! I recommend [reading the source](https://github.com/progrium/topframe/blob/main/topframe.go) as its only a few hundred lines,
65+
but otherwise there is a [wiki](https://github.com/progrium/topframe/wiki) ready to document anything else.
6566

6667
## Getting Help
6768

68-
* forum
69+
If you're having trouble, be sure to check [issues](https://github.com/progrium/topframe/issues) to see if its a known issue. Otherwise, feel free to drop
70+
a question into the [discussion forum](https://github.com/progrium/topframe/discussions).
6971

7072
## Contributing
7173

72-
* maintainers wanted
73-
* small PRs welcome
74-
* big PRs discuss first
74+
Ideally, topframe will be kept small. Bug fixes and other small PRs are welcome and should be merged quickly.
75+
If you happen to have a large PR that we haven't discussed, you should talk about it in the forum first. In order
76+
to keep the project small, some features suggestions may be held back in favor of determining a good extension point to expose instead.
7577

7678
## About
7779

0 commit comments

Comments
 (0)