initial-commit
This commit is contained in:
20
README.md
Normal file
20
README.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Taker of Notes Plugin: S3
|
||||
|
||||
Taker of Notes storage plugin for S3 compatible object storage
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Install dependencies: `npm install`
|
||||
2. Run tests: `npm test`
|
||||
3. Build: `npm run build`
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `src/` - Source code
|
||||
- `test/` - Tests
|
||||
- `dist/` - Built output
|
||||
- `rollup.config.js` - Build configuration
|
||||
|
||||
## Development
|
||||
|
||||
Implement your storage adapter in `src/S3Adapter.js`.
|
||||
Reference in New Issue
Block a user