Prepare crate for publishing
This commit is contained in:
parent
87154e3385
commit
7041e723d5
|
@ -2,6 +2,11 @@
|
|||
name = "circe"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
license = "Unlicense"
|
||||
description = "IRC crate in Rust"
|
||||
repository = "https://git.karx.xyz/circe.git"
|
||||
readme = "README.md"
|
||||
exclude = ["src/main.rs", "config.toml"]
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
|
|
24
LICENSE
Normal file
24
LICENSE
Normal file
|
@ -0,0 +1,24 @@
|
|||
This is free and unencumbered software released into the public domain.
|
||||
|
||||
Anyone is free to copy, modify, publish, use, compile, sell, or
|
||||
distribute this software, either in source code form or as a compiled
|
||||
binary, for any purpose, commercial or non-commercial, and by any
|
||||
means.
|
||||
|
||||
In jurisdictions that recognize copyright laws, the author or authors
|
||||
of this software dedicate any and all copyright interest in the
|
||||
software to the public domain. We make this dedication for the benefit
|
||||
of the public at large and to the detriment of our heirs and
|
||||
successors. We intend this dedication to be an overt act of
|
||||
relinquishment in perpetuity of all present and future rights to this
|
||||
software under copyright law.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
|
||||
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
|
||||
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
For more information, please refer to <https://unlicense.org>
|
27
README.md
Normal file
27
README.md
Normal file
|
@ -0,0 +1,27 @@
|
|||
# Circe
|
||||
|
||||
`Circe` is a an IRC crate built to be as minimal as possible. It's currently work-in-progress, and more stuff is on its way!
|
||||
|
||||
## Getting started
|
||||
|
||||
To start using Circe, just add the crate to your `Cargo.toml`, and then follow the example below.
|
||||
|
||||
```rust
|
||||
use circe::{Client, Config, Command};
|
||||
|
||||
fn main() -> Result<(), std::io::Error> {
|
||||
let config = Config::from_toml("config.toml")?;
|
||||
let mut client = Client::new(config)?;
|
||||
client.identify()?;
|
||||
|
||||
loop {
|
||||
if let Ok(ref command) = client.read() {
|
||||
if let Command::OTHER(line) = command {
|
||||
print!("{}", line);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Happy hacking!
|
Loading…
Reference in a new issue