Skip to content

Commit 67a730a

Browse files
better readme for thefiche
1 parent fa16dc5 commit 67a730a

1 file changed

Lines changed: 4 additions & 18 deletions

File tree

examples/TheFiche/README.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TheFiche
22

3-
TheFiche is a Python module that generates and exports Logseq pages based on WDoc queries. It provides functionality to create structured Logseq pages with content generated from WDoc queries, including metadata and properties.
3+
TheFiche is a script that generates and exports [Logseq](https://github.com/logseq/logseq) pages based on [WDoc](https://github.com/thiswillbeyourgithub/WDoc/) queries. It provides functionality to create structured Logseq pages with content generated from WDoc queries, including metadata and properties.
44

55
## Features
66

@@ -12,17 +12,15 @@ TheFiche is a Python module that generates and exports Logseq pages based on WDo
1212
## Installation
1313

1414
To use TheFiche, you need to have WDoc and its dependencies installed. Make sure you have the following prerequisites:
15-
16-
- Python 3.7+
17-
- WDoc library
18-
- LogseqMarkdownParser
15+
- WDoc
16+
- [LogseqMarkdownParser](https://github.com/thiswillbeyourgithub/LogseqMarkdownParser) (by me also)
1917
- fire
2018
- beartype
2119

2220
You can install the required dependencies using pip:
2321

2422
```
25-
pip install wdoc logseq-markdown-parser fire beartype
23+
python -m pip install -U WDoc LogseqMarkdownParser fire beartype
2624
```
2725

2826
## Usage
@@ -66,15 +64,3 @@ TheFiche generates a Logseq page with the following components:
6664
- Number of documents found, filtered, and used
6765
- Query details and timestamp
6866
- TheFiche version and execution date
69-
70-
## License
71-
72-
[Include license information here]
73-
74-
## Contributing
75-
76-
[Include contribution guidelines or link to CONTRIBUTING.md]
77-
78-
## Support
79-
80-
[Include support information or contact details]

0 commit comments

Comments
 (0)