Skip to content

Commit b2139f3

Browse files
committed
organize into directories
1 parent 9bac93c commit b2139f3

File tree

11 files changed

+202
-184
lines changed

11 files changed

+202
-184
lines changed

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
.idea
22
node_modules
33
.staticrypt.json
4-
/cli/README.md
5-
/cli/LICENSE
6-
/cli/password_template.html
4+
/www/password_template.html

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,19 +133,26 @@ The salt isn't secret, so you don't need to worry about hiding the config file.
133133

134134
## Contributing
135135

136+
### Source Directories
137+
138+
- `cli/` - The command-line interface published to NPM.
139+
- `example/` - This file is encrypted as part of the build. The encrypted file is committed both to make this library easy to explore and as a review-time sanity check.
140+
- `lib/` - Files shared across www and cli.
141+
- `scripts/` - Build, test, deploy, CI, etc. See `npm run-script`.
142+
- `www/` - The source for the in-browser encryption site hosted at https://robinmoisson.github.io/staticrypt.
143+
136144
### Build
137145
Built assets are committed to main. Run build before submitting a PR or publishing to npm.
138146

139147
```
140148
# From staticrypt/
141-
$ cd cli
142149
$ npm install
143150
$ npm run build
144151
```
145152

146153
### Test
147154
Testing is currently manual to keep dependencies low.
148-
[Build](#build), then open `example_encypted.html`.
155+
[Build](#build), then open `example/example_encypted.html`.
149156

150157
## 🙏 Contribution
151158

0 commit comments

Comments
 (0)