Skip to content

Commit 46b538a

Browse files
committed
docs: update tool's README files
The alfred tool needs a bit more instruction for installation as we now have a monorepo. The server tool needs a lot of work and thus a note was added for the time being. The shared package (notion-scripts) was simplified down for the time being.
1 parent d311336 commit 46b538a

File tree

3 files changed

+10
-68
lines changed

3 files changed

+10
-68
lines changed

alfred/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,16 @@ There is a bit of setup required to make this project work as intended.
1717

1818
### Get the workflow in Alfred
1919

20-
Create a _Blank Workflow_ and dump the contents of this repository into it.
20+
Create a _Blank Workflow_ and dump the contents of this sub-directory into it.
2121

2222
![](./workflow.png)
2323

24+
Another option is to symlink the repository's sub-directory into the workflow directory (paths will vary in the example depending on where things are located):
25+
26+
```
27+
ln -s ~/path/to/notion-tools/alfred ~/path/to/Alfred.alfredpreferences/workflows
28+
```
29+
2430
### Python
2531

2632
There are certain Python dependencies that are required for the scripts to work correctly. You need to navigate to the workflow's directory so that you can execute `pip3 install -r requirements.txt` from your terminal. Alternatively, you can manually install what is defined in the `./requirements.txt`.

server/README.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
<h1 align="center">Welcome to notion-heroku 👋</h1>
2-
<p align="center">
3-
<a href="https://github.com/kevinjalbert/notion-heroku/blob/master/LICENSE">
4-
<img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-yellow.svg" target="_blank" />
5-
</a>
6-
<a href="https://twitter.com/kevinjalbert">
7-
<img alt="Twitter: kevinjalbert" src="https://img.shields.io/twitter/follow/kevinjalbert.svg?style=social" target="_blank" />
8-
</a>
9-
</p>
1+
# 🚧 README is out of date (as of December 26, 2019) 🚧
102

113
> Heroku hosted application that performs [Notion](https://www.notion.so/) actions (i.e., new task, new note) based on voice requests via [IFTTT Webhooks](https://ifttt.com/maker_webhooks) and [Google Assistant](https://ifttt.com/google_assistant).
124
@@ -73,17 +65,3 @@ The main difference is that the webhook URL is either `/add_note` or `/add_task`
7365
![Step 6](./step6.png)
7466

7567
</details>
76-
77-
## Author
78-
79-
👤 **Kevin Jalbert**
80-
81-
* Twitter: [@kevinjalbert](https://twitter.com/kevinjalbert)
82-
* Github: [@kevinjalbert](https://github.com/kevinjalbert)
83-
84-
## Show your support
85-
86-
Give a ⭐️ if this project helped you!
87-
88-
***
89-
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

shared/README.md

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,4 @@
1-
<h1 align="center">Welcome to notion_scripts 👋</h1>
2-
<p align="center">
3-
<img alt="Version" src="https://img.shields.io/badge/version-v0.2.1-blue.svg?cacheSeconds=2592000" />
4-
<a href="https://github.com/kevinjalbert/notion-scripts/blob/master/LICENSE">
5-
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" target="_blank" />
6-
</a>
7-
<a href="https://twitter.com/kevinjalbert">
8-
<img alt="Twitter: kevinjalbert" src="https://img.shields.io/twitter/follow/kevinjalbert.svg?style=social" target="_blank" />
9-
</a>
10-
</p>
11-
12-
> Shared collection of common Notion Scripts used in my projects
13-
14-
## Install
15-
16-
This package is using Python 3.
17-
18-
```sh
19-
pip install git+https://github.com/kevinjalbert/notion-scripts
20-
```
1+
Shared collection of common Notion scripts used in other tools in this repository.
212

223
## Usage
234

@@ -31,29 +12,6 @@ notion_api.current_day()
3112
notion_api.append_to_current_day_notes("title of a note")
3213
```
3314

34-
For more detailed usage I would recommend taking a look at [`alfred-notion`](https://github.com/kevinjalbert/alfred-notion) and [`notion-heroku`](https://github.com/kevinjalbert/notion-heroku).
15+
For more detailed usage I would recommend taking a look at the [alfred](/../alfred/) and [server](/../server/) tools.
3516

3617
A more completed set of features and instructions will be provided soon.
37-
38-
## Author
39-
40-
👤 **Kevin Jalbert**
41-
42-
* Twitter: [@KevinJalbert](https://twitter.com/KevinJalbert)
43-
* Github: [@kevinjalbert](https://github.com/kevinjalbert)
44-
45-
## 🤝 Contributing
46-
47-
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/kevinjalbert/notion-scripts/issues).
48-
49-
## Show your support
50-
51-
Give a ⭐️ if this project helped you!
52-
53-
## 📝 License
54-
55-
Copyright © 2019 [Kevin Jalbert](https://github.com/kevinjalbert).<br />
56-
This project is [MIT](https://github.com/kevinjalbert/notion-scripts/blob/master/LICENSE) licensed.
57-
58-
***
59-
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

0 commit comments

Comments
 (0)