From 18c8284ba99a9ce10e04a6691fde5d3551adc545 Mon Sep 17 00:00:00 2001 From: Bauke Date: Thu, 6 Aug 2020 17:45:18 +0200 Subject: [PATCH] Move to self-hosted Gitea, clean up stuff. --- .gitlab-ci.yml | 17 ------------ Cargo.toml | 8 +++--- License-Apache => LICENSE-Apache | 0 LICENSE-MIT | 21 ++++++++++++++ License-MIT | 7 ----- README.md | 31 +++++++++++++++++++++ ReadMe.md | 37 ------------------------- source/lib.rs | 14 +++++----- tests/spec_samples/{License => LICENSE} | 0 9 files changed, 63 insertions(+), 72 deletions(-) delete mode 100644 .gitlab-ci.yml rename License-Apache => LICENSE-Apache (100%) create mode 100644 LICENSE-MIT delete mode 100644 License-MIT create mode 100644 README.md delete mode 100644 ReadMe.md rename tests/spec_samples/{License => LICENSE} (100%) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml deleted file mode 100644 index a336098..0000000 --- a/.gitlab-ci.yml +++ /dev/null @@ -1,17 +0,0 @@ -stages: - - build - -rust-latest: - stage: build - image: rust:latest - script: - - cargo build --verbose - - cargo test --verbose - -rust-nightly: - stage: build - image: rustlang/rust:nightly - script: - - cargo build --verbose - - cargo test --verbose - allow_failure: true diff --git a/Cargo.toml b/Cargo.toml index 8598416..ef5f71c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,11 +3,11 @@ [package] name = "opml" authors = ["Holllo "] -version = "0.2.2" -license = "MIT/Apache-2.0" +version = "0.2.3" +license = "MIT OR Apache-2.0" description = "An OPML parser for Rust." -repository = "https://gitlab.com/holllo/opml-rs" -readme = "ReadMe.md" +repository = "https://git.holllo.cc/holllo/opml" +readme = "README.md" edition = "2018" keywords = ["xml", "opml"] diff --git a/License-Apache b/LICENSE-Apache similarity index 100% rename from License-Apache rename to LICENSE-Apache diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..8817388 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2020 Holllo + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +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 OR COPYRIGHT HOLDERS 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. diff --git a/License-MIT b/License-MIT deleted file mode 100644 index ba2c8ec..0000000 --- a/License-MIT +++ /dev/null @@ -1,7 +0,0 @@ -Copyright 2020 Holllo - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -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 OR COPYRIGHT HOLDERS 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..228fbbb --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# OPML + +> An OPML parser for Rust. + +## Getting Started + +```rust +use opml::OPML; + +let xml = r#""#; +let parsed = OPML::new(xml).unwrap(); + +println!("{:#?}", parsed); +``` + +Check out [the documentation](https://docs.rs/opml/) for further details. + +## CLI + +Looking for a command-line utility to parse OPML documents? Check out [the `opml-cli`](https://git.holllo.cc/Holllo/opml-cli/), a small wrapper around this crate that will let you do just that. + +## License + +Open-sourced with either the + +* [Apache License, Version 2.0](https://git.holllo.cc/Holllo/opml/src/branch/main/LICENSE-Apache) (http://www.apache.org/licenses/LICENSE-2.0) +* [MIT license](https://git.holllo.cc/Holllo/opml/src/branch/main/LICENSE-MIT) (http://opensource.org/licenses/MIT) + +at your option. + +The samples [located in `tests/spec_samples`](https://git.holllo.cc/Holllo/opml/src/branch/main/tests/spec_samples) were [taken from the OPML 2.0 spec](http://dev.opml.org/spec2.html#examples) and are subject to [their own license](https://git.holllo.cc/Holllo/opml/src/branch/main/tests/spec_samples/LICENSE). diff --git a/ReadMe.md b/ReadMe.md deleted file mode 100644 index 3e057db..0000000 --- a/ReadMe.md +++ /dev/null @@ -1,37 +0,0 @@ -# OPML - -> An OPML parser for Rust. - -## Contents - -* [Examples](examples/) -* [Expertise Welcome](#expertise-welcome) -* [License](#license) - -## Expertise Welcome - -This is the first crate I'm publishing to crates.io and the first proper library I've made for Rust. Any help or tips with how to improve the API, documentation, usability, testing or anything else is very welcome. Feel free to create [an issue](https://gitlab.com/holllo/opml-rs/issues/) or contact me via email at helllo@holllo.cc. - -## Getting Started - -```rust -use opml::OPML; - -let xml = r#""#; -let parsed = OPML::new(xml).unwrap(); - -println!("{:#?}", parsed); -``` - -Check out [the documentation](https://docs.rs/opml/) for further details. - -## License - -Open-sourced with either the - -* [Apache License, Version 2.0](License-Apache) (http://www.apache.org/licenses/LICENSE-2.0) -* [MIT license](License-MIT) (http://opensource.org/licenses/MIT) - -at your option. - -The samples [located in `tests/spec_samples`](tests/spec_samples) were [taken from the OPML 2.0 spec](http://dev.opml.org/spec2.html#examples) and are subject to [their own license](tests/spec_samples/License). diff --git a/source/lib.rs b/source/lib.rs index 5e23e5e..a498b5d 100644 --- a/source/lib.rs +++ b/source/lib.rs @@ -45,21 +45,22 @@ //! let expected = r#"Rust Feeds"#; //! println!("{}", xml); //! assert_eq!(xml, expected); -//! //! ``` //! +//! ## CLI +//! +//! Looking for a command-line utility to parse OPML documents? Check out [the `opml-cli`](https://git.holllo.cc/Holllo/opml-cli/), a small wrapper around this crate that will let you do just that. +//! //! ## License //! //! Open-sourced with either the //! -//! * [Apache License, Version 2.0](https://gitlab.com/holllo/opml-rs/-/blob/master/License-Apache) (http://www.apache.org/licenses/LICENSE-2.0) -//! * [MIT license](https://gitlab.com/holllo/opml-rs/-/blob/master/License-MIT) (http://opensource.org/licenses/MIT) +//! * [Apache License, Version 2.0](https://git.holllo.cc/Holllo/opml/src/branch/main/LICENSE-Apache) (http://www.apache.org/licenses/LICENSE-2.0) +//! * [MIT license](https://git.holllo.cc/Holllo/opml/src/branch/main/LICENSE-MIT) (http://opensource.org/licenses/MIT) //! //! at your option. //! -//! The samples [located in `tests/spec_samples`](https://gitlab.com/holllo/opml-rs/-/blob/master/tests/spec_samples) were [taken from the OPML 2.0 spec](http://dev.opml.org/spec2.html#examples) and are subject to [their own license](https://gitlab.com/holllo/opml-rs/-/blob/master/tests/spec_samples/License). - -// TODO: Maybe use a date-time type for all the date-time places? +//! The samples [located in `tests/spec_samples`](https://git.holllo.cc/Holllo/opml/src/branch/main/tests/spec_samples) were [taken from the OPML 2.0 spec](http://dev.opml.org/spec2.html#examples) and are subject to [their own license](https://git.holllo.cc/Holllo/opml/src/branch/main/tests/spec_samples/LICENSE). use regex::Regex; use serde::{Deserialize, Serialize}; @@ -87,7 +88,6 @@ impl OPML { /// /// # Example /// - /// /// ```rust /// use opml::{OPML, Outline}; /// diff --git a/tests/spec_samples/License b/tests/spec_samples/LICENSE similarity index 100% rename from tests/spec_samples/License rename to tests/spec_samples/LICENSE