docs: add readme and supplementary files

.eslintrc.json

@@ -0,0 +1,21 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "env": { "node": true },
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parserOptions": {
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": ["error", { "args": "none" }],
+    "@typescript-eslint/ban-ts-comment": "off",
+    "no-prototype-builtins": "off",
+    "@typescript-eslint/no-empty-function": "off"
+  }
+}

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-04-28
+
+Initial release!
+
+### Added
+
+- Very rudimentary plain text viewing and editing of Klog files.
+
+[0.1.0]: https://github.com/ovyerus/obsidian-klog/releases/tag/0.1.0

LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2024, Ovyerus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,125 +1,23 @@
-# Obsidian Sample Plugin
+# Klog Obsidian Plugin
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+An [Obsidian](https://obsidian.md) plugin adding support for the
+[Klog](https://klog.jotaen.net/) plaintext time-tracking file format.
 
-This project uses Typescript to provide type checking and documentation. The
-repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition
-format, which contains TSDoc comments describing what it does.
+![preview screenshot](./preview.png)
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at
-any time!
+## Installation
 
-This sample plugin demonstrates some of the basic functionality the plugin API
-can do.
+This plugin is not yet submitted to the community plugins repository, so you
+will need to manually install by grabbing the
+[latest release](https://github.com/ovyerus/obsidian-klog/releases/latest) and
+placing the files into `<vault>/.obsidian/plugins/obsidian-klog`, or by checking
+out the repository in the same location, and building it.
 
-- Adds a ribbon icon, which shows a Notice when clicked.
-- Adds a command "Open Sample Modal" which opens a Modal.
-- Adds a plugin setting tab to the settings page.
-- Registers a global click event and output 'click' to the console.
-- Registers a global interval which logs 'setInterval' to the console.
+## Roadmap
 
-## First time developing plugins?
-
-Quick starting guide for new plugin devs:
-
-- Check if
-  [someone already developed a plugin for what you want](https://obsidian.md/plugins)!
-  There might be an existing plugin similar enough that you can partner up with.
-- Make a copy of this repo as a template with the "Use this template" button
-  (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place
-  this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be
-  automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under
-  your repo folder.
-
-## Releasing new releases
-
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and
-  the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with
-  `"new-plugin-version": "minimum-obsidian-version"` so older versions of
-  Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version".
-  Use the exact version number, don't include a prefix `v`. See here for an
-  example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary
-  attachments. Note: The manifest.json file must be in two places, first the
-  root path of your repository and also in the release.
-- Publish the release.
-
-> You can simplify the version bump process by running `npm version patch`,
-> `npm version minor` or `npm version major` after updating `minAppVersion`
-> manually in `manifest.json`. The command will bump version in `manifest.json`
-> and `package.json`, and add the entry for the new version to `versions.json`
-
-## Adding your plugin to the community plugin list
-
-- Check
-  https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add
-  your plugin.
-
-## How to use
-
-- Clone this repo.
-- Make sure your NodeJS is at least v16 (`node --version`).
-- `npm i` or `yarn` to install dependencies.
-- `npm run dev` to start compilation in watch mode.
-
-## Manually installing the plugin
-
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault
-  `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-## Improve code quality with eslint (optional)
-
-- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly
-  find problems. You can run ESLint against your plugin to find common bugs and
-  ways to improve your code.
-- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by
-    file and line number.
-- If your source code is in a folder, such as `src`, you can use eslint with
-  this command to analyze all files in that folder:
-  - `eslint .\src\`
-
-## Funding URL
-
-You can include funding URLs where people who use your plugin can financially
-support it.
-
-The simple way is to set the `fundingUrl` field to your link in your
-`manifest.json` file:
-
-```json
-{
-  "fundingUrl": "https://buymeacoffee.com"
-}
-```
-
-If you have multiple URLs, you can also do:
-
-```json
-{
-  "fundingUrl": {
-    "Buy Me a Coffee": "https://buymeacoffee.com",
-    "GitHub Sponsor": "https://github.com/sponsors",
-    "Patreon": "https://www.patreon.com/"
-  }
-}
-```
-
-## API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+- [ ] Text formatting/Rich text previews
+  - Requires a JS parser for the format.
+- [ ] Make Obsidian aware of Klog tags.
+- [ ] Command palette integration.
+- [ ] Try do some cool stuff with time summaries/previews.
+- [ ] Possibly add a Dataview integration?