Skip to content

Commit fc3f270

Browse files
committed
Updating documents
1 parent 6635eb5 commit fc3f270

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,25 @@
22

33
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/e9c631a50f8c4018925d0aaedbb38d30)](https://www.codacy.com/app/garethcmurphy/CatanieDataLoad?utm_source=github.com&utm_medium=referral&utm_content=datacurationproject/CatanieDataLoad&utm_campaign=badger)
44

5-
One Paragraph of project description goes here
5+
[![Build Status](https://travis-ci.org/datacurationproject/CatanieDataLoad.svg?branch=master)](https://travis-ci.org/datacurationproject/CatanieDataLoad)
6+
7+
8+
9+
This repository contains classes to load synthetic metadata to the scicat data catalogue, for testing and benchmarking purposes.
10+
611

712
## Getting Started
813

9-
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
14+
You can just use Docker
1015

1116
### Prerequisites
1217

18+
Docker
19+
1320
Node
21+
1422
Typescript
23+
1524
Catanie
1625

1726

@@ -36,7 +45,14 @@ End with an example of getting some data out of the system or using it for a lit
3645

3746
## Running the tests
3847

39-
Explain how to run the automated tests for this system
48+
Tests use mocha
49+
50+
You can try running
51+
```
52+
npm test
53+
```
54+
55+
Tests should run automatically on travis-ci.org
4056

4157
### Break down into end to end tests
4258

@@ -80,7 +96,7 @@ See also the list of [contributors](https://github.com/your/project/contributors
8096

8197
## License
8298

83-
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
99+
This project is licensed under the GPL-3 License - see the [LICENSE](LICENSE) file for details
84100

85101
## Acknowledgments
86102

0 commit comments

Comments
 (0)