@@ -6,19 +6,23 @@ If you are new to Slack app development, you will want to learn about it on
66[ Slack's website] ( https://api.slack.com/start ) . This library is only useful if you already understand the basics of
77building Slack applications.
88
9- ## :warning : WARNING: Under Heavy Development
10-
11- This is under heavy development and dogfooding. _ Breaking changes may occur on any commit._ Also, the project is
12- lacking test coverage and documentation, so use at your own risk (as is the case with most OSS).
13- - For questions, feedback, suggestions, etc., use [ Discussions] [ ] .
14- - For issues or concerns, use [ Issues] [ ] .
15-
169## Installation
1710
1811- Requires PHP 7.4+
1912- Use Composer to install: ` composer require slack-php/slack-app-framework `
2013
21- ## Usage
14+ ## General Usage
15+
16+ ### Quick Warning
17+
18+ This library has been heavily dogfooded, but the project is severely lacking in test coverage and documentation, so
19+ use it at your own risk, as the MIT license advises.
20+
21+ - Contributions welcome (especially for documentation and tests).
22+ - For questions, feedback, suggestions, etc., use [ Discussions] [ ] .
23+ - For issues or concerns, use [ Issues] [ ] .
24+
25+ ### Development Patterns
2226
2327When creating an app, you can configure your app from the Slack website. The framework is designed to recieve requests
2428from all of your app's interaction points, so you should configure all of the URLs (e.g., in ** Slash Commands** ,
@@ -279,7 +283,7 @@ $ctx->container(): ContainerInterface // Returns an instance of the configured P
279283
280284## Not Implemented
281285
282- This project is a WIP. The following are known to be missing:
286+ The following features are known to be missing:
283287
284288- OAuth flow for handling installations to a different workspace.
285289 - Though there are some class in the ` SlackPhp\Framework\Auth ` namespace if you need to roll your own right now.
0 commit comments