chore(name): update repo name to match new convention

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Self-Encryption - Change Log
+# Self Encryption - Change Log
 
 ## [0.19.0]
 

Cargo.toml

@@ -7,7 +7,7 @@ homepage = "https://maidsafe.net"
 license = "GPL-3.0"
 name = "self_encryption"
 readme = "README.md"
-repository = "https://github.com/maidsafe/self-encryption"
+repository = "https://github.com/maidsafe/self_encryption"
 version = "0.19.0"
 
 [dependencies]

README.md

@@ -1,4 +1,4 @@
-# self-encryption
+# self_encryption
 
 Self encrypting files (convergent encryption plus obfuscation)
 
@@ -16,7 +16,7 @@ A version of [convergent encryption](http://en.wikipedia.org/wiki/Convergent_enc
 1. This library deals with file content **only**
 2. This library provides very secure data, but does return a data structure (DataMap) that in turn requires to be secured.
 
-![image of self encryption](https://github.com/maidsafe/self-encryption/blob/master/img/self-encryption.png?raw=true)
+![image of self encryption](https://github.com/maidsafe/self_encryption/blob/master/img/self_encryption.png?raw=true)
 
 ## Video of the process
 [self_encryption process and use case video](https://www.youtube.com/watch?v=Jnvwv4z17b4)

src/error.rs

@@ -13,7 +13,7 @@ use std::{
     io::Error as IoError,
 };
 
-/// Errors which can arise during self-encryption or -decryption.
+/// Errors which can arise during self_encryption or -decryption.
 #[derive(Debug)]
 pub enum SelfEncryptionError<E: StorageError> {
     /// An error during compression or decompression.

src/lib.rs

@@ -6,7 +6,7 @@
 // KIND, either express or implied. Please review the Licences for the specific language governing
 // permissions and limitations relating to use of the SAFE Network Software.
 
-//! A file **content** self-encryptor.
+//! A file **content** self_encryptor.
 //!
 //! This library provides convergent encryption on file-based data and produce a `DataMap` type and
 //! several chunks of data. Each chunk is up to 1MB in size and has a name.  This name is the
@@ -96,7 +96,7 @@
 
 //! ```
 //!
-//! Using this `SimpleStorage`, a self-encryptor can be created and written to/read from:
+//! Using this `SimpleStorage`, a self_encryptor can be created and written to/read from:
 //!
 //! ```
 //! # extern crate futures;
@@ -195,7 +195,7 @@ pub use crate::{
     storage::{Storage, StorageError},
 };
 
-/// The maximum size of file which can be self-encrypted, defined as 1GB.
+/// The maximum size of file which can be self_encrypted, defined as 1GB.
 pub const MAX_FILE_SIZE: usize = 1024 * 1024 * 1024;
 /// The maximum size (before compression) of an individual chunk of the file, defined as 1MB.
 pub const MAX_CHUNK_SIZE: u32 = 1024 * 1024;

src/self_encryptor.rs

@@ -70,7 +70,7 @@ where
 {
     /// This is the only constructor for an encryptor object.  Each `SelfEncryptor` is used for a
     /// single file.  The parameters are a `Storage` object and a `DataMap`.  For a file which has
-    /// not previously been self-encrypted, use `DataMap::None`.
+    /// not previously been self_encrypted, use `DataMap::None`.
     #[allow(clippy::new_ret_no_self)]
     pub fn new(
         storage: S,

src/sequential/encryptor.rs

@@ -113,7 +113,7 @@ where
 ///
 /// This encryptor differs from `SelfEncryptor` in that completed chunks will be stored during
 /// `write()` calls as opposed to buffering all data until the `close()` call.  This should give
-/// more realistic feedback about the progress of fully self-encrypting larger data.
+/// more realistic feedback about the progress of fully self_encrypting larger data.
 ///
 /// A further difference is that since the entire data is not held in an internal buffer, this
 /// encryptor doesn't need to limit the input data size, i.e. `MAX_FILE_SIZE` does not apply to this

src/storage.rs

@@ -12,7 +12,7 @@ use std::error::Error;
 /// `Storage` object.
 pub trait StorageError: Error {}
 
-/// Trait which must be implemented by storage objects to be used in self-encryption.  Data is
+/// Trait which must be implemented by storage objects to be used in self_encryption.  Data is
 /// passed to the storage object encrypted with `name` being the SHA3-256 hash of `data`.  `Storage`
 /// could be implemented as an in-memory `HashMap` or a disk-based container for example.
 #[async_trait]