Skip to content

Commit

Permalink
docs: exception name
Browse files Browse the repository at this point in the history
  • Loading branch information
arthurfiorette committed Aug 13, 2021
1 parent f7ac178 commit 5321670
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,6 @@ dependencies {
}
```

```sbt
// Sbt
resolvers += "jitpack" at "https://jitpack.io"

libraryDependencies += "com.github.ArthurFiorette" % "sink-library" % "VERSION"
```

<br />

### Documentation
Expand All @@ -144,7 +137,7 @@ While the documentation is not done, you can look at the [examples](/docs/exampl

### Commons problems

#### `IllegalComponentException`
#### `GenericComponentException`

This exception is thrown when you try to register a component or service, in your class that extends SinkPlugin, which is generic. Since the ComponentManager manages its objects with the key being their classes, two classes with different generic types would be recognized as the same component.

Expand All @@ -166,6 +159,16 @@ And then you can register the `MyStringClass` normally.

<br />

### Help needed.

If you are willing to contribute in any manner. Checking out this list can be helpful

- **Documentation** *(Urgent haha)*
- **English revision.** *(My english is really bad)*
- **Testing this code under other spigot versions**

<br />

### License

Licensed under the **MIT**. See [`LICENSE`](LICENSE) for more informations.
Expand Down

0 comments on commit 5321670

Please sign in to comment.