Skip to content

Commit

Permalink
basic readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ze-kel committed Apr 11, 2022
1 parent d5d4531 commit 8bab439
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### BkzLogger

App to store data about books you've read in plaintext markdown.
Goodreads-like functionality except for all the social stuff.
Integrates perfectly with your markdown notes in Obsidian or similar apps.

![](./docs_content/image.png)

### Disclaimer

For me this is a project to learn and play with stuff, it's not a production app. Use at your own risk.
Commits making it closer to being usable are always appreciated. I may not care enough to implement the feature you want but enought to review and merge your PR.

### Developing

```npm run watch``` to run in dev mode

```npm run test``` to run e2e tests

```npm run compile``` to build for production
Binary file added docs_content/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion packages/renderer/src/utils/formatHeader.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { useStore } from '../use/store';
import type { IOpened } from '/@main/watcher/openedTabs';

const capitalize = (string: string) => {
Expand Down

0 comments on commit 8bab439

Please sign in to comment.