Skip to content

Commit

Permalink
Update README.md (#67)
Browse files Browse the repository at this point in the history
  • Loading branch information
sujaya-sys authored Dec 14, 2023
2 parents 102324b + 0e0803a commit ccc1674
Showing 1 changed file with 13 additions and 23 deletions.
36 changes: 13 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,5 @@
![Score banner](/images/banner.png)

# ![Score](/images/logo.svg) Score overview

Score is an open source, platform-agnostic, container-based workload specification. This means you can define your workload once with the _Score Specification_ and then use a _Score Implementation_ CLI to translate it to multiple platforms, such as Helm, Docker Compose or Google Cloud Run.

## ![Contributing](/images/contributing.svg) Contributing

- Write a [blog](https://score.dev/blog).
- Provide feedback on our [road map and releases board](https://github.com/orgs/score-spec/projects).
- Contribute.

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also open an issue with the tag `enhancement`.

1. Fork the Project.
2. Create your Feature Branch. `git checkout -b feature/feature-name`
3. Commit your Changes. `git commit -s -m "Add some AmazingFeature"`
4. Push to the Branch. `git push origin feature/feature-name`
5. Open a Pull Request.

Read [CONTRIBUTING](CONTRIBUTING.md) for more information.

## Docs

This section covers how to build the documentation site with Hugo.
Expand Down Expand Up @@ -167,6 +145,18 @@ rm package-lock.json

You can find our documentation at [docs.score.dev](https://docs.score.dev/docs/).

### Contribute

If you have a suggestion to improve our documentation, please fork the repo and create a pull request. You can also open an issue with the tag `enhancement`.

1. Fork the Project.
2. Create your Feature Branch. `git checkout -b feature/feature-name`
3. Commit your Changes. `git commit -s -m "Add some amazing documentation enhancement"`
4. Push to the Branch. `git push origin feature/feature-name`
5. Open a Pull Request.

Read [CONTRIBUTING](CONTRIBUTING.md) for more information.

### Roadmap

See [Roadmap](roadmap.md). You can [submit an idea](https://github.com/score-spec/spec/issues/new) anytime.
Expand All @@ -177,4 +167,4 @@ See [Roadmap](roadmap.md). You can [submit an idea](https://github.com/score-spe

### Code of conduct

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

0 comments on commit ccc1674

Please sign in to comment.