Skip to content

Commit 80faff9

Browse files
committed
Add a package readme for npm
1 parent 6dd45ba commit 80faff9

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

lib/importer/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
2+
# Data Upload Design Kit
3+
4+
## Description
5+
6+
The Data Upload Design Kit makes it easier for users to upload data about many things
7+
at once by uploading a file without the need for hard-coded Excel spreadsheets. Designed to work with the [GOV.UK Prototype Kit](https://prototype-kit.service.gov.uk/), it makes it easier for service designers and developers to test.
8+
9+
The kit achieves this by empowering the user to choose which sheet and data to use, and which columns to map to the required output data in an easy to use and configurable way. The kit currently supports the upload of:
10+
11+
* CSV files,
12+
* Excel files (.xls, and .xlsx), and
13+
* OpenDocument spreadsheets (.ods)
14+
15+
You can learn more about the problems that inspired this package at in our blog posts about our presentation at [Services Week 2025](https://services.blog.gov.uk/2025/01/30/get-involved-with-services-week-2025/)
16+
17+
* [Why services suck at spreadsheets](https://www.register-dynamics.co.uk/blog/why-services-suck-at-spreadsheets),
18+
* [How to design better spreadsheet templates](https://www.register-dynamics.co.uk/blog/how-to-design-better-spreadsheet-templates).
19+
20+
21+
22+
## Install
23+
24+
To install the package, you should run the following command from the directory containing your gov.uk prototype. It will install and configure itself into your prototype.
25+
26+
```
27+
npm install @register-dynamics/importer
28+
```
29+
30+
## Help
31+
32+
Once you have installed the plugin, and launched your prototype with `npm run dev` you can find the most recent documentation about the plugin you have installed [within the prototype](http://127.0.0.1:3000/plugin-assets/%40register-dynamics%2Fimporter/assets/docs/). The documentation for the most recent released version is also [available online](https://data-importer.register-dynamics.co.uk/plugin-assets/%40register-dynamics%2Fimporter/assets/docs/).
33+
34+
## Contact us
35+
36+
To discuss this package, obtain help, or request features, please feel free to reach out to us by email via `hello [at] register-dynamics.co.uk`.

0 commit comments

Comments
 (0)