Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dotMavriQ authored Jul 12, 2024
1 parent ba4de5e commit 1b90ec5
Showing 1 changed file with 5 additions and 41 deletions.
46 changes: 5 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,55 +2,19 @@

Obsitica-Web is a web service that allows you to export your Habits, ToDo's, and Dailies from Habitica into a format suitable for journaling in Obsidian. This tool helps streamline your habit tracking and journaling process, making it easier to keep track of your progress and stay organized.

## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)

## Features
- Export Habits, ToDo's, and Dailies from Habitica.
- Generate a formatted output compatible with Obsidian.
- Simple and user-friendly interface.

## Installation
To get started with Obsitica-Web, follow these steps:

1. Clone the repository:
```bash
git clone https://github.com/dotmavriq/obsitica-web.git
```
2. Navigate to the project directory:
```bash
cd obsitica-web
```
3. Install the required dependencies:
```bash
npm install
```

## Usage
To use Obsitica-Web, follow these steps:

1. Start the web server:
```bash
npm start
```
2. Open your browser and navigate to:
```
http://localhost:3000
```
3. Follow the instructions on the web interface to connect your Habitica account and export your data.

4. Copy the formatted output and paste it into your Obsidian journal.

## Configuration
To configure Obsitica-Web, you can modify the following settings in the `config.json` file:

- `habitica_api_url`: The API endpoint for Habitica.
- `output_format`: Customize the format of the exported data to suit your journaling style.
1. Visit the [Obsitica-Web](https://dotmavriq.github.io/obsitica-web/) page.
2. Enter your Habitica User ID and API Token to connect your account.
3. Select the type of data you want to export (Habits, ToDo's, Dailies).
4. Click on the "Export" button to generate the formatted output.
5. Copy the generated text and paste it into your Obsidian journal.

## Contributing
We welcome contributions to Obsitica-Web! If you would like to contribute, please follow these steps:
Expand Down

0 comments on commit 1b90ec5

Please sign in to comment.