This repository has been archived on 2023-04-26. You can view files and clone it, but cannot push or open issues or pull requests.
nimcord/src/nimcord.nim

24 lines
1.1 KiB
Nim
Raw Normal View History

2020-06-22 20:57:42 +00:00
## Welcome to NimCord Documentation!
##
## NimCord is a Discord API wrapper written in Nim.
## Its created by SeanOMik, who also created [DisC++](https://github.com/DisCPP/DisCPP),
## a Discord API wrapper written in C++.
##
## Because of my (SeanOMik) work with C++, I made sure to make NimCord
## member optimized but keep it simple to use and feature rich.
##
## Each modules are split in an object fashion. So `client` handles all gateway stuff,
## `member` defines the GuildMember type and some procs to modify it.
##
## The module `nimcordutils` defined some helper procs. Currently (as of 0.0.1) these
## procs are only used by Nimcord and likely wont be useful to the user.
2020-06-22 20:41:32 +00:00
import nimcord/[cache, channel, client, clientobjects, discordobject]
import nimcord/[embed, eventdispatcher, guild, image, member, message]
import nimcord/[nimcordutils, permission, presence, role, user]
export cache, channel, client, clientobjects, discordobject
export embed, eventdispatcher, guild, image, member, message
export nimcordutils, permission, presence, role, user
2020-06-22 20:57:42 +00:00
const NimCordVersion = "v0.0.1"