Skip to content

Commit

Permalink
Update documentation again
Browse files Browse the repository at this point in the history
  • Loading branch information
ZekeSnider committed Aug 22, 2020
1 parent 6eb9221 commit 2666bed
Show file tree
Hide file tree
Showing 13 changed files with 7 additions and 207 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Generated by Apple Swift version 5.2.4 effective-4.2 (swiftlang-1103.0.32.9 clang-1103.0.32.53)
// Generated by Apple Swift version 5.2.4 (swiftlang-1103.0.32.9 clang-1103.0.32.53)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wgcc-compat"

Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

This file was deleted.

4 changes: 3 additions & 1 deletion Documentation/SampleModule/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,6 @@ This is a sample project to demonstrate how a third party plugin can be built. T
* In `Info.plist` set `JaredFrameworkVersion` to the correct version
* In `Info.plist` set `Principal class` to be the the subclass of `RoutingModule` that should be used.

To create the routing module you must subclass `RoutingModule`. Routes can be defined and added to the `routes` member variable. Action handler methods must accept a `Message` variable and return void. They can call `Jared.Send` to send a message. You can construct a `RecipientEntity` yourself, or you can just call `message.RespondTo()` to respond to the incoming message.
To create the routing module you must subclass `RoutingModule`. Routes can be defined and added to the `routes` member variable. Action handler methods must accept a `Message` variable and return void. Your initializer will receive a `MessageSender` object, and you can use it at any time to send messages. You can construct a `RecipientEntity` yourself, or you can just call `message.RespondTo()` to respond to the incoming message.

If you use `self` for callbacks, be very careful to use a weak reference, [to avoid memory leaks](https://zeke.dev/automatic-reference-counting-with-self/).
Binary file modified Documentation/Screenshots/Example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion Documentation/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ By using either native plugins, or a webhook configuration, you can define route

## Parameters

`name`: A string for the name of the route. This must be globally unique.
`name`: A string for the name of the route. This must be globally unique.
`comparisons`: A dictionary of `[Comapare: [String]]` that defines triggers for your route. The following is a list of `Compare` types:

+ `startsWith`: String starts with
Expand Down
4 changes: 2 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@
Please check out the [release](https://github.com/ZekeSnider/Jared/releases/latest) page for an up to date pre-compiled download.

## What is Jared?
![Jared usage screenshot](/Documentation/Screenshots/Example.png)

A powerful and easily extensible iMessage bot. It makes it possible to add chat bot features to any iMessage conversation. It includes some basic commands built in. API integrations, games, custom emotes, and much more can be added by using webhooks, the REST API, or by installing plugins.

![Jared usage screenshot](/Documentation/Screenshots/Example.png)

Any pull requests and new GitHub issues are much appreciated! If you would like to develop a plugin for Jared, see the plugin section below. I'm always available on [Twitter](https://twitter.com/zekesnider) if you have any ideas/suggestions.

## Installation
Expand Down

0 comments on commit 2666bed

Please sign in to comment.