Skip to content

Commit

Permalink
chore: Temporal Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ji Sang Seo committed Feb 11, 2024
1 parent a0e5365 commit 142f5e7
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 1 deletion.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "oh-my-task",
"version": "0.0.1",
"description": "OH-MY-TASK is mainly focusing helping indie developers to manage their projects neatly.",
"description": "OH-MY-TASK is mainly focused on helping indie developers to manage their projects neatly.",
"main": "cli/oh-my-task.mjs",
"bin": {
"omt": "cli/oh-my-task.mjs",
Expand Down
74 changes: 74 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1 +1,75 @@
# OH-MY-TASK

## Installation

```
npm i -g oh-my-task
```

## Initialize

- 1. Create history file (Only once just after installing package globally)

```
omt init -g
```

- 2. Create local project configuration

```
omt init
```

## Useage

#### Challenge 1 : General task life cycle

-> Create task

```
omt create
```

-> Select task

```
omt select
```

-> Send Pull Request (after works)

```
omt pr
```

-> Finish Task

```
omt finish
```

#### Challenge 2 : Speedy selection

-> Create task with base branch to current branch and select right away

```
omt create -s -c
```

#### Challenge 3 : Select from existing Tasks

```
omt select
```

#### Challenge 4 : Select from existing Tasks base on current branch

```
omt select -c
```

#### Challenge 5 : Sync task histories to (SyncFile) (default :: README.md)

```
omt sync
```

0 comments on commit 142f5e7

Please sign in to comment.