Skip to content

Commit 806f679

Browse files
committed
Basic readme
1 parent 10fb95f commit 806f679

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,31 @@
22

33
This gem was built to replace azure-storage-blob (deprecated) in Active Storage, but was written to be Rails agnostic.
44

5+
## Contributing
6+
7+
### dev environment
8+
9+
Ensure your version of Ruby fit the minimum version in `azure-blob.gemspec`
10+
11+
and setup those Env variables:
12+
13+
- `AZURE_ACCOUNT_NAME`
14+
- `AZURE_ACCESS_KEY`
15+
- `AZURE_PRIVATE_CONTAINER`
16+
- `AZURE_PUBLIC_CONTAINER`
17+
18+
19+
A dev environment setup is also supplied through Nix with [devenv](https://devenv.sh/).
20+
21+
To use the Nix environment:
22+
1- install [devenv](https://devenv.sh/)
23+
2- Copy `devenv.local.nix.example` to `devenv.local.nix`
24+
3- Insert your azure credentials into `devenv.local.nix`
25+
4- Start the shell with `devenv shell` or with [direnv](https://direnv.net/).
26+
27+
### Tests
28+
29+
`bin/rake test`.
530

631
# Active Storage
732

0 commit comments

Comments
 (0)