Skip to content

Commit beca974

Browse files
committed
Update README
1 parent af6d3e6 commit beca974

File tree

2 files changed

+11
-27
lines changed

2 files changed

+11
-27
lines changed

README.md

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,14 @@
1-
# DSW Plugin Template
1+
# maDMP Importer Plugin
22

3-
Template repository to create DSW plugins.
3+
_Import from maDMP in JSON according to the [RDA DMP Common Standard](https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard)_
44

5-
## Get Started
5+
## Changelog
66

7-
1. Fill in the [project metadata](src/metadata.ts).
8-
1. Define [settings](src/data/settings-data.ts) and [user settings](src/data/user-settings-data.ts) data using [zod](https://zod.dev).
9-
- If you don't want to have any settings, you can delete these files and use `PluginBuilder.createWithNoSettings` instead.
10-
- If you want just one, you can delete the other and create a null codec instead using `makeNullCodec()`.
11-
1. Start implementing your plugin by defining the components in the [components](src/components) folder and adding them to the PluginBuilder in [plugin.ts](src/plugin.ts). See [@ds-wizard/plugin-sdk](https://github.com/ds-wizard/dsw-plugin-sdk) for more details.
7+
### 0.1.0
128

13-
## Useful Commands
9+
Initial version based on [DSW Replies Importer](https://github.com/ds-wizard/dsw-replies-importer).
1410

15-
- `npm run build` = creates a production build of the plugin
16-
- `npm run dev` = watch for file changes and run the dev server (you can change the port in package.json)
17-
- `npm run typecheck` = check for type errors
18-
- `npm run lint` = run linter
19-
- `npm run format` = format the code (however, it is more convenient to set up formatter directly in VS Code, see below)
11+
## License
2012

21-
### Formatter in VS Code
22-
23-
Create `.vscode/settings.json` for easier code editing:
24-
25-
```json
26-
{
27-
"editor.formatOnSave": true,
28-
"editor.defaultFormatter": "esbenp.prettier-vscode"
29-
}
30-
```
13+
This project is licensed under the MIT License - see the
14+
[LICENSE](LICENSE) file for more details.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"name": "dsw-plugin",
3-
"version": "1.0.0",
2+
"name": "madmp-importer-plugin",
3+
"version": "0.1.0",
44
"description": "",
5-
"license": "ISC",
5+
"license": "MIT",
66
"author": "",
77
"type": "module",
88
"scripts": {

0 commit comments

Comments
 (0)