Skip to content

Commit 8ee4c52

Browse files
authored
docs: modify Readme (#161)
1 parent 4da22f7 commit 8ee4c52

File tree

1 file changed

+6
-19
lines changed

1 file changed

+6
-19
lines changed

README.md

+6-19
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,16 @@ The project includes:
88
- [Hooks](./hooks)
99
- [Tests](./tests)
1010

11-
## Environment
1211

13-
Run the following command to setup the go workspace.
12+
## Contributing
1413

15-
```
16-
make workspace-init
17-
```
14+
Interested in contributing? Great, we'd love your help! To get started, take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.
1815

19-
Additional workspace commands:
16+
## Useful links
2017

21-
```go
22-
make workspace-update // sync go.work with current modules
23-
make test // test all go modules
24-
make lint // lint all go modules
25-
make MODULE_NAME=NAME new-provider // create and setup new provider directory (requires jq)
26-
make MODULE_NAME=NAME new-hook // create and setup new hook directory (requires jq)
27-
```
28-
> [jq documentation](https://stedolan.github.io/jq/download/)
29-
30-
## Releases
31-
32-
This repo uses _Release Please_ to release packages. Release Please sets up a running PR that tracks all changes for the library components, and maintains the versions according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), generated when [PRs are merged](https://github.com/amannn/action-semantic-pull-request). When Release Please's running PR is merged, any changed artifacts are published.
18+
* For more information on OpenFeature, visit [openfeature.dev](https://openfeature.dev)
19+
* For help or feedback on this project, join us on [Slack](https://cloud-native.slack.com/archives/C0344AANLA1) or create a [GitHub issue](https://github.com/open-feature/js-sdk-contrib/issues/new/choose).
3320

3421
## License
3522

36-
Apache 2.0 - See [LICENSE](./LICENSE) for more information.
23+
Apache 2.0 - See [LICENSE](./LICENSE) for more information.

0 commit comments

Comments
 (0)