Skip to content

Commit 1822f23

Browse files
committed
Update README.md
1 parent 191a49f commit 1822f23

File tree

1 file changed

+54
-8
lines changed

1 file changed

+54
-8
lines changed

README.md

Lines changed: 54 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,56 @@
1-
# Orbital Starter
1+
<!-- <p align="center">
2+
<a href="http://atomizecode">
3+
<img width="110px" style="margin-right: 20px" src="https://firebasestorage.googleapis.com/v0/b/pawan-dev.appspot.com/o/logo.svg?alt=media">
4+
</a>
5+
</p> -->
26

3-
This repository will help you get started on your first Orbital CLI.
7+
<h1 align="center">Nebula CLI</h1>
48

5-
1. Clone this repository: `git clone https://github.com/orbital-js/starter.git`
6-
2. Run `npm install`
7-
3. Test your CLI with `ts-node src/main.ts say`
8-
4. Build the CLI code: `npm run build`
9-
5. Create a symlink to run it from your command line: `npm link`
10-
6. Try it as a global command: `starter say`
9+
<div align="center">
10+
11+
CaliStyle Developer Tools
12+
13+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/CaliStyle/nebula/issues)
14+
15+
</div>
16+
17+
## Features
18+
19+
- Clean and Check your code
20+
- Automate basic dev tasks
21+
22+
## Install
23+
24+
Oops 🙊 We don't have a package yet! Follow the instructions below and use the developer version for the time being!
25+
26+
## Development
27+
28+
To clone locally:
29+
30+
```bash
31+
git clone https://github.com/calistyle/nebula.git
32+
cd nebula
33+
npm install
34+
```
35+
36+
To test locally:
37+
38+
```bash
39+
ts-node src/main.ts [command]
40+
```
41+
42+
To build locally:
43+
44+
```bash
45+
npm run build
46+
npm run link
47+
nb [command]
48+
```
49+
50+
## Built With
51+
52+
- [Orbital Js](https://orbital-js.github.io/docs/guide/introduction/) - A CLI Framework by [@wbhob](https://wilsonhobbs.com)
53+
54+
## Contributing
55+
56+
Read our [contributing guide](#) and let's build a better nebula together.

0 commit comments

Comments
 (0)