Skip to content

Commit 048bede

Browse files
committed
docs: fix license, better README
Signed-off-by: Artemis Lavasa <[email protected]>
1 parent 143c4ba commit 048bede

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

Diff for: LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 Ivan Goncharov
3+
Copyright (c) 2019-2021 CERN.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

Diff for: README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,26 @@
1-
# CAP API Documentation OpenAPI Specification
21

3-
## Working on specification
4-
### Install
52

3+
# CERN Analysis Preservation REST API Documentation
4+
5+
### About
6+
----
7+
This is the documentation behind the REST API for [CERN Analysis Preservation](https://analysispreservation.cern.ch/).
8+
9+
Other documentation:
10+
- [CERN Analysis Preservation Docs](https://analysispreservation.cern.ch/docs/general/)
11+
- [CERN Analysis Preservation Client](https://analysispreservation.cern.ch/docs/cli/)
12+
13+
If you need help or have a question about the API Documentation, please contact us via our [email]([email protected]).
14+
15+
# OpenAPI Specification
16+
17+
### Install
18+
---
619
1. Install [Node JS](https://nodejs.org/)
720
2. Clone repo and run `npm install` in the repo root
821

922
### Usage
23+
---
1024

1125
#### `npm start`
1226
Starts the development server.

0 commit comments

Comments
 (0)