https://github.com/alveflo/yaml-todos

A todo list generator using yaml as input data.
https://github.com/alveflo/yaml-todos

Last synced: 14 days ago
JSON representation

A todo list generator using yaml as input data.

• Host: GitHub
• URL: https://github.com/alveflo/yaml-todos
• Owner: alveflo
• Created: 2014-10-02T16:20:17.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-10-06T20:25:15.000Z (about 10 years ago)
• Last Synced: 2024-12-16T01:02:42.974Z (18 days ago)
• Language: JavaScript
• Homepage:
• Size: 2.6 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# yaml-todos

A todo list generator using yaml as input data.

#### installation

This application runs on [node.js](http://nodejs.org) and is installed via node package manager:

```

> (sudo) npm install -g yaml-todos

```

#### run

```

> (sudo) yaml-todos -f file_name.yaml

```

#### syntax

The input yaml file must have a 'todos' key. This is simply because the web app is looking for this key when listing the tasks. See below for correct input syntax

```yaml

todos:

  - : 

  - : 

  - : 

  - : 

```

#### example

1 - Create a yaml-file containing your todo-list:

*todos.yaml*

```yaml

todos:

  - Install: Install this application from npm

  - Write todos: Write a todo list

  - Run: Run the application

```

2 - Run the application

```

> (sudo) yaml-todos -f todos.yaml

```

3 - Done! [Image](https://raw.githubusercontent.com/victoralveflo/yaml-todos/master/img/example.png)

#### license

MIT