Skip to content
This repository has been archived by the owner on Mar 10, 2020. It is now read-only.

chore/ci: initial setup #20

Merged
merged 2 commits into from
Jun 28, 2018
Merged

chore/ci: initial setup #20

merged 2 commits into from
Jun 28, 2018

Conversation

S-Coyle
Copy link
Contributor

@S-Coyle S-Coyle commented Jun 13, 2018

Updated/Created:

  • Cargo.toml
  • license files
  • README.md
  • .gitignore
  • CHANGELOG.md

@S-Coyle S-Coyle requested a review from canndrew June 13, 2018 16:13
.gitignore Outdated
target
Cargo.lock
.direnv.*
Skip to content

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the first 18 and last 13 lines of this have been accidentally copied in?

"Carl Lerche <me@carllerche.com>",
"Andrew Cann <shum@canndrew.org>",
]
authors = ["MaidSafe Developers <dev@maidsafe.net>"]
description = "tokio-based uTP implementation"
documentation = "https://docs.rs/tokio-utp"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this documentation = link may break once this crate renaming goes through.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed name = back to tokio-utp so that should resolve this issue (no crate renaming will occur)

@@ -5,11 +5,13 @@ An implementation of [UTP] for Rust using non-blocking sockets.

|Crate|Documentation|Linux/OS X|Windows|Issues|
|:---:|:-----------:|:--------:|:-----:|:----:|
|[![](http://meritbadge.herokuapp.com/tokio-utp)](https://crates.io/crates/tokio-utp)|[![Documentation](https://docs.rs/tokio-utp/badge.svg)](https://docs.rs/tokio-utp)|[![Build Status](https://travis-ci.org/maidsafe/tokio-utp.svg?branch=master)](https://travis-ci.org/maidsafe/tokio-utp)|[![Build status](https://ci.appveyor.com/api/projects/status/wk7vqat3xhly1ny1/branch/master?svg=true)](https://ci.appveyor.com/project/MaidSafe-QA/tokio-utp/branch/master)|[![Stories in Ready](https://badge.waffle.io/maidsafe/tokio-utp.png?label=ready&title=Ready)](https://waffle.io/maidsafe/tokio-utp)|
|[![](http://meritbadge.herokuapp.com/tokio-utp)](https://crates.io/crates/tokio-utp)|[![Documentation](https://docs.rs/tokio-utp/badge.svg)](https://docs.rs/tokio-utp)|[![Build Status](https://travis-ci.org/maidsafe/tokio_utp.svg?branch=master)](https://travis-ci.org/maidsafe/tokio_utp)|[![Build status](https://ci.appveyor.com/api/projects/status/wk7vqat3xhly1ny1/branch/master?svg=true)](https://ci.appveyor.com/project/MaidSafe-QA/tokio-utp/branch/master)|[![Stories in Ready](https://badge.waffle.io/maidsafe/tokio_utp.png?label=ready&title=Ready)](https://waffle.io/maidsafe/tokio_utp)|

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the crates.io links may remain valid after the renaming, but not so sure about the others. To be safe (and consistent with our other projects), it'd be better to change all instances of tokio-utp to tokio_utp except the AppVeyor link.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed name = back to tokio-utp so that should resolve this issue (no crate renaming will occur). Means inconsistency within this file as crate, docs and Appveyor links will still be tokio-utp, while the rest will be tokio_utp.

README.md Outdated
Licensed under the ([MIT](LICENSE)) license.
Licensed under:
* the Modified BSD ([LICENSE-BSD](https://opensource.org/licenses/BSD-3-Clause)) or
* the MIT license ([LICENSE-MIT](http://opensource.org/licenses/MIT))

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

http: to https:?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated 👍

Cargo.toml Outdated
license = "MIT/Apache-2.0"
name = "tokio-utp"
repository = "https://github.com/canndrew/tokio-utp"
license = "MIT/BSD"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line should be

license = "MIT OR BSD-3-Clause"

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so basically pls use whatever is there in safe_app @StephenCoyleAtMaidSafe , to be consistent

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated 👍

@@ -1,3 +1,232 @@
target
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls use safe_client_libs's .gitignore

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now updated 👍

Cargo.toml Outdated
license = "MIT/Apache-2.0"
name = "tokio-utp"
repository = "https://github.com/canndrew/tokio-utp"
license = "MIT/BSD"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so basically pls use whatever is there in safe_app @StephenCoyleAtMaidSafe , to be consistent

Cargo.toml Outdated
name = "tokio-utp"
repository = "https://github.com/canndrew/tokio-utp"
license = "MIT/BSD"
name = "tokio_utp"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also let's call this tokio-utp in line with all the tokio prefixed crates in crates.io. Here's a list from @povilasb for reference: https://docs.rs/releases/search?query=tokio

Our repo is still tokio_utp which is fine and in line with our convention

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated 👍

povilasb
povilasb previously approved these changes Jun 28, 2018
@S-Coyle S-Coyle changed the title Name change and general updates chore/ci: initial setup Jun 28, 2018
@ustulation ustulation merged commit c80c6b4 into maidsafe-archive:master Jun 28, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants