Skip to content

Commit

Permalink
docs: upgrade REAME document
Browse files Browse the repository at this point in the history
  • Loading branch information
JonDotsoy committed Aug 8, 2024
1 parent 4f8420e commit 342a601
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,39 @@ You can see a live version of this project at https://jondotsoy.github.io/your-l

This project generates markdown files, one per week, outlining the structure of human life. The idea is to visualize how each stage of life fits together and help you appreciate the importance of every moment.

## Licensing
## Using the Generated Document

This project is licensed under the MIT License. See [LICENSE](./LICENSE) for details.
The generated document starts with a title section for each week, containing the number of the week and the corresponding date. Each section can include events, where each paragraph is considered an event. To use this document effectively:

### Long Events

* To declare events that start on a certain date and end on a certain date, use the key words "Inicia", "Comienza", "Start".
* If you find a similar event, you can close the event if you encounter another future event that starts with the word "Termina", "Finaliza", "Concluye", "Finish".

Example:

```md
## Week 1096 - Sat Jul 14 2012

Start my work at the amazing company

## Week 1409 - Sat Jul 14 2018

Finish my work at the amazing company
```

### Individual Events

* By default, each paragraph is declared as an individual event.
* You can highlight or categorize the event if you wish.

Example:

```md
## Week 1350 - Sat May 27 2017

Won the award for best fantasy writer 2017
```

## Contributing

Expand Down

0 comments on commit 342a601

Please sign in to comment.