Skip to content

princesslana/smalld

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SmallD

Build Technical Debt Code Coverage Discord

SmallD aims to be a minmalist client for the Discord API. It aims to let you use the Discord API, without hiding or abstracting it.

Features considered in scope:

  • Authentication, Identifying, Resuming
  • Hearbeat
  • Rate Limiting

Features considered out of scope:

  • Serialization or deserialization os JSON messages/payloads
  • Caching

Usage

Also see https://smalld.readthedocs.io.

Latest Release: Maven Central Javadocs

Add as a dependency to maven, using the latest release version:

  <dependency>
    <groupId>com.github.princesslana</groupId>
    <artifactId>smalld</artifactId>
    <version>LASTEST_VERSION</version>
  </dependency>

Development Version

Use jitpack.

Add the repository:

  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>

Add the dependency:

  <dependency>
    <groupId>com.github.princesslana</groupId>
    <artifactId>smalld</artifactId>
    <version>main-SNAPSHOT</version>
  </dependency>

Contact

Reach out to the Discord Projects Hub on Discord and look for the smalld channels.

Development

To run the junit tests:

$ mvn test

To run the code formatter:

$ mvn spotless:apply

To run the full set of verifications (including test coverage and style checks):

$ mvn verify