Skip to content

Commit df5f5f6

Browse files
docs: add readme (#68)
As we are getting more devs from other teams contributing, i want to have a simple readme which documents the changeset and release process.
1 parent 1597c88 commit df5f5f6

File tree

1 file changed

+56
-1
lines changed

1 file changed

+56
-1
lines changed

README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,56 @@
1-
# chainlink-deployments-framework
1+
<div align="center">
2+
<h1>Chainlink Deployments Framework</h1>
3+
<a><img src="https://github.com/smartcontractkit/chainlink-deployments-framework/actions/workflows/push-main.yml/badge.svg" /></a>
4+
<br/>
5+
<br/>
6+
</div>
7+
8+
9+
This repository contains the Chainlink Deployments Framework, a comprehensive set of libraries that enables developers to build, manage, and execute(in future) deployment changesets.
10+
The framework includes the Operations API and Datastore API.
11+
12+
## Usage
13+
14+
```bash
15+
# for writing changesets (migrated from chainlink/deployments
16+
$ go get github.com/smartcontractkit/chainlink-deployments-framework/deployment
17+
18+
# for operations api
19+
$ go get github.com/smartcontractkit/chainlink-deployments-framework/operations
20+
21+
# for datastore api
22+
$ go get github.com/smartcontractkit/chainlink-deployments-framework/datastore
23+
```
24+
25+
## Development
26+
27+
28+
### Installing Dependencies
29+
30+
Install the required tools using [asdf](https://asdf-vm.com/guide/getting-started.html):
31+
32+
```bash
33+
asdf install
34+
```
35+
36+
### Linting
37+
38+
```bash
39+
task lint
40+
```
41+
42+
### Testing
43+
44+
```bash
45+
task test
46+
```
47+
48+
## Contributing
49+
50+
For instructions on how to contribute to `chainlink-deployments-framework` and the release process,
51+
see [CONTRIBUTING.md](https://github.com/smartcontractkit/chainlink-deployments-framework/blob/main/CONTRIBUTING.md)
52+
53+
## Releasing
54+
55+
For instructions on how to release `chainlink-deployments-framework`,
56+
see [RELEASE.md](https://github.com/smartcontractkit/chainlink-deployments-framework/blob/main/RELEASE.md)

0 commit comments

Comments
 (0)