Skip to content

Commit 24dabe9

Browse files
authored
docs: add description and usage (#18)
Updated README with brief description and usage.
1 parent 17a4c2d commit 24dabe9

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1-
# Orb
1+
# Core Orb [![CircleCI Build Status](https://circleci.com/gh/ExtensionEngine/pipeline-core-orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/ExtensionEngine/pipeline-core-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/studion/core.svg)](https://circleci.com/developer/orbs/orb/studion/core) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/ExtensionEngine/pipeline-core-orb/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)
22

3-
[![CircleCI Build Status](https://circleci.com/gh/ExtensionEngine/pipeline-core-orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/ExtensionEngine/pipeline-core-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/studion/core.svg)](https://circleci.com/developer/orbs/orb/studion/core) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/ExtensionEngine/pipeline-core-orb/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)
3+
An orb to facilitate Node.js work within Studion CircleCI pipelines. Inspired by CircleCI Node Orb.\
4+
Key features:
5+
- Support for pnpm using Corepack, and npm
6+
- Ensure the specific version/tag of the package manager is installed
7+
- The default value of the package manager is picked from the environment
8+
- Install dependencies with caching enabled by default
9+
- Run scripts defined inside a package.json using a command for better composition
10+
- Can only run in execution environments with Node.js pre-installed
411

5-
## Resources
12+
## Usage
613

7-
[CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/studion/core) - The official registry page of this orb for all versions, executors, commands, and jobs described.
14+
See [the official registry page](https://circleci.com/developer/orbs/orb/studion/core) of this orb for guidelines and examples.

0 commit comments

Comments
 (0)