Skip to content

Commit cc96e73

Browse files
committed
Say in the README that this is a template to clone, not a product
The framing existed only in a code comment ("OpenBot exists to be forked"), which is the wrong place for the first thing somebody needs to know: that there is nothing to sign up for, nothing to install as a dependency, and that the example tenant package is a worked example to replace rather than a default to keep. Read without it, "Quick start" looks like the way you use OpenBot rather than the way you try the starting point before making it yours. Placed above the alpha and laptop callouts because it frames both.
1 parent 61e2065 commit cc96e73

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ your own machine.
2525

2626
</div>
2727

28+
> **A template, not a product.** OpenBot is meant to be cloned and made your own. There is no hosted version to sign up for, and nothing here is published as a package to depend on: every workspace in this repository is private. You take the repository, replace the example tenant package under `examples/` with your own coworkers, channels and skills, and run it. Everything below describes a starting point, not a finished thing somebody operates for you.
29+
2830
> **Alpha, and under active development.** OpenBot is early. Expect rough edges and bugs, and expect things to move. Issues and pull requests are welcome.
2931
3032
> **Runs on your machine.** Everything below is written for a laptop. `.env.example` carries `OPENBOT_SINGLE_USER=true`, which admits every request as one administrator, so a fresh clone reaches the product without registering an OAuth client first. [Sign-in](#sign-in) turns that off, and is required before anybody else can reach the deployment.

0 commit comments

Comments
 (0)