From 11f04d8d5984ba239f3c9af79db398a31576b0b1 Mon Sep 17 00:00:00 2001 From: Jordan Doyle Date: Thu, 13 Feb 2020 05:33:31 +0000 Subject: [PATCH] Prepare for cargo publish --- LICENSE | 1 + LICENSE-0BSD | 5 +++++ LICENSE-WTFPL | 13 +++++++++++++ README.md | 13 ++++++++++++- stork/Cargo.toml | 12 +++++++----- stork_http/Cargo.toml | 16 +++++++++------- stork_http/src/lib.rs | 2 +- 7 files changed, 48 insertions(+), 14 deletions(-) create mode 100644 LICENSE create mode 100644 LICENSE-0BSD create mode 100644 LICENSE-WTFPL diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6ef8e06 --- /dev/null +++ b/LICENSE @@ -0,0 +1 @@ +WTFPL OR 0BSD \ No newline at end of file diff --git a/LICENSE-0BSD b/LICENSE-0BSD new file mode 100644 index 0000000..2136cb9 --- /dev/null +++ b/LICENSE-0BSD @@ -0,0 +1,5 @@ +Copyright (C) 2020 by Jordan Doyle + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/LICENSE-WTFPL b/LICENSE-WTFPL new file mode 100644 index 0000000..07b7a81 --- /dev/null +++ b/LICENSE-WTFPL @@ -0,0 +1,13 @@ + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + Version 2, December 2004 + +Copyright (C) 2004 Sam Hocevar + +Everyone is permitted to copy and distribute verbatim or modified +copies of this license document, and changing it is allowed as long +as the name is changed. + + DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. You just DO WHAT THE FUCK YOU WANT TO. \ No newline at end of file diff --git a/README.md b/README.md index 9a9eb08..0c1176f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # stork.rs -`stork` is a basic website scraper written in Rust. \ No newline at end of file + + [![License: WTFPL](https://img.shields.io/badge/License-WTFPL-brightgreen.svg?style=flat-square&logo=appveyor)](http://www.wtfpl.net/about/) ![https://docs.rs/stork/](https://docs.rs/stork/badge.svg) [![Downloads](https://img.shields.io/crates/d/stork.svg?style=flat-square&logo=appveyor)](https://crates.io/crates/stork) + +`stork` is a simple futures-based library to recursively crawl +sources in a search engine-like fashion. stork was designed from the +ground to have a simple API that is easy to use and can be reused +across multiple protocols, yielding each result giving end users the +freedom to do BFS, DFS or any type of search they may so wish. + +View the docs for examples of how to use `stork`: +- [stork](https://docs.rs/stork/) +- [stork_http](https://docs.rs/stork_http/) \ No newline at end of file diff --git a/stork/Cargo.toml b/stork/Cargo.toml index bdea895..378eac9 100644 --- a/stork/Cargo.toml +++ b/stork/Cargo.toml @@ -2,16 +2,18 @@ name = "stork" version = "0.0.1" authors = ["Jordan Doyle "] +description = "simple futures-based library to recursively crawl sources in a search engine-like fashion" +license = "WTFPL OR 0BSD" edition = "2018" [dependencies] -failure = "" -failure_derive = "" +failure = "0.1.6" +failure_derive = "0.1.6" -dyn-clone = "" +dyn-clone = "1.0.1" -futures = "0.3" -async-stream = "" +futures = "0.3.4" +async-stream = "0.2.1" [dev-dependencies] tokio = { version = "0.2", features = ["full"] } \ No newline at end of file diff --git a/stork_http/Cargo.toml b/stork_http/Cargo.toml index 014cfd1..e4f514f 100644 --- a/stork_http/Cargo.toml +++ b/stork_http/Cargo.toml @@ -2,20 +2,22 @@ name = "stork_http" version = "0.0.1" authors = ["Jordan Doyle "] +description = "first-party stork implementation for HTML-based web scraping" +license = "WTFPL OR 0BSD" edition = "2018" [dependencies] -stork = { path = "../stork" } +stork = { path = "../stork", version = "0.0.1" } -select = "" +select = "0.4.3" reqwest = { version = "0.10.1", features = ["gzip"] } -url = "" +url = "2.1.1" -failure = "" -failure_derive = "" +failure = "0.1.6" +failure_derive = "0.1.6" -futures = "0.3" -async-stream = "" +futures = "0.3.4" +async-stream = "0.2.1" [dev-dependencies] stork = { path = "../stork" } diff --git a/stork_http/src/lib.rs b/stork_http/src/lib.rs index 399e7f1..5e25ac4 100644 --- a/stork_http/src/lib.rs +++ b/stork_http/src/lib.rs @@ -1,5 +1,5 @@ //! # stork_http -//! This is a [stork](../stork/index.html) implementation for the HTTP +//! This is a [stork](../../../stork/index.html) implementation for the HTTP //! protocol and specifically HTML-based web scraping. Given an initial //! page to scrape, stork_http will find all indexable links on the page //! and yield them back to you - ready to scrape again in an instant -- libgit2 1.7.2