diff --git a/README.md b/README.md index 4ea223e..a5cd6c0 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# crypto_secret.cr -[![Crystal CI](https://github.com/didactic-drunk/crypto_secret.cr/actions/workflows/crystal.yml/badge.svg)](https://github.com/didactic-drunk/crypto_secret.cr/actions/workflows/crystal.yml) -[![GitHub release](https://img.shields.io/github/release/didactic-drunk/crypto_secret.cr.svg)](https://github.com/didactic-drunk/crypto_secret.cr/releases) -![GitHub commits since latest release (by date) for a branch](https://img.shields.io/github/commits-since/didactic-drunk/crypto_secret.cr/latest) -[![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://didactic-drunk.github.io/crypto_secret.cr/master) +# crypto-secret.cr +[![Crystal CI](https://github.com/didactic-drunk/crypto-secret.cr/actions/workflows/crystal.yml/badge.svg)](https://github.com/didactic-drunk/crypto-secret.cr/actions/workflows/crystal.yml) +[![GitHub release](https://img.shields.io/github/release/didactic-drunk/crypto-secret.cr.svg)](https://github.com/didactic-drunk/crypto-secret.cr/releases) +![GitHub commits since latest release (by date) for a branch](https://img.shields.io/github/commits-since/didactic-drunk/crypto-secret.cr/latest) +[![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://didactic-drunk.github.io/crypto-secret.cr/master) Interface intended to hold sensitive information. @@ -12,8 +12,8 @@ Interface intended to hold sensitive information. ```yaml dependencies: - crypto_secret: - github: didactic-drunk/crypto_secret + crypto-secret: + github: didactic-drunk/crypto-secret ``` 2. Run `shards install` @@ -21,7 +21,7 @@ Interface intended to hold sensitive information. ## Usage ```crystal -require "crypto_secret/not" +require "crypto-secret/not" not_secret = Crypto::Secret::Not.new 32 ``` @@ -51,7 +51,7 @@ end ## Contributing -1. Fork it () +1. Fork it () 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) @@ -59,7 +59,6 @@ end ## Contributors -- [simple](https://github.com/your-github-user) - creator and maintainer - [didactic-drunk](https://github.com/didactic-drunk) - current maintainer [![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://didactic-drunk.github.io/sodium.cr/master) # sodium.cr diff --git a/shard.yml b/shard.yml index 0331a40..f8f8d91 100644 --- a/shard.yml +++ b/shard.yml @@ -1,4 +1,4 @@ -name: crypto_secret +name: crypto-secret version: 0.1.0 authors: diff --git a/spec/not_spec.cr b/spec/not_spec.cr index 0a7e485..bc6cc8b 100644 --- a/spec/not_spec.cr +++ b/spec/not_spec.cr @@ -1,5 +1,5 @@ require "./spec_helper" -require "../src/crypto_secret/not" +require "../src/crypto-secret/not" describe Crypto::Secret::Not do it "works" do diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr index 02d03ce..3283538 100644 --- a/spec/spec_helper.cr +++ b/spec/spec_helper.cr @@ -1,2 +1,2 @@ require "spec" -require "../src/crypto_secret" +require "../src/crypto-secret" diff --git a/src/crypto_secret.cr b/src/crypto-secret/crypto-secret.cr similarity index 100% rename from src/crypto_secret.cr rename to src/crypto-secret/crypto-secret.cr diff --git a/src/crypto_secret/not.cr b/src/crypto-secret/not.cr similarity index 100% rename from src/crypto_secret/not.cr rename to src/crypto-secret/not.cr