Skip to content

Commit dfa292d

Browse files
committed
update README.org
1 parent faeb386 commit dfa292d

File tree

1 file changed

+67
-51
lines changed

1 file changed

+67
-51
lines changed

README.org

Lines changed: 67 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ A comprehensive Pushbullet client for GNU Emacs that allows you to send and mana
44

55
* Features
66

7+
- Interactive UI: Browse and manage your pushes in a dedicated Emacs buffer
78
- Send Notes: Send text notes to Pushbullet with custom titles
89
- Region Pushing: Push selected text regions to your devices
910
- Clipboard Integration: Send clipboard contents to Pushbullet
10-
- Interactive UI: Browse and manage your pushes in a dedicated Emacs buffer
11-
- Modern Interface: Beautiful formatting with icons and proper typography
1211
- Pagination Support: Load multiple pages of pushes efficiently
12+
- Export Pushes to Org-Mode
1313

1414
* Installation
1515

@@ -49,9 +49,9 @@ A comprehensive Pushbullet client for GNU Emacs that allows you to send and mana
4949

5050
2. Configure the token in Emacs:
5151
#+BEGIN_SRC elisp
52-
(setq pushbullet-token "your-api-token-here")
52+
(setq pushbullet-api-token "your-api-token-here")
5353
#+END_SRC
54-
Or use =M-x customize-variable RET pushbullet-token=
54+
Or use =M-x customize-variable RET pushbullet-api-token=
5555

5656
3. Alternatively, just add an entry for `pushbullet.com` (lower-case) in your `.authinfo.gpg`:
5757
#BEGIN_SRC authinfo
@@ -61,39 +61,41 @@ A comprehensive Pushbullet client for GNU Emacs that allows you to send and mana
6161
** Optional Configuration
6262

6363
#+BEGIN_SRC elisp
64-
;; Number of pushes to fetch per request (default: 20)
65-
(setq pushbullet-limit 20)
64+
;; Number of pushes to fetch per request
65+
(setq pushbullet-api-limit 50)
6666

67-
;; Default title for pushes (default: "GNU Emacs <version>")
67+
;; Default title for pushes
6868
(setq pushbullet-default-title "My Emacs")
6969

70-
;; Maximum columns for text wrapping (default: 108)
71-
(setq pushbullet-columns 80)
70+
;; Maximum columns for text wrapping
71+
(setq pushbullet-columns 100)
7272

7373
;; Enable debug logging (default: nil)
74-
(setq pushbullet-debug t)
74+
(setq pushbullet-debug t
75+
pushbullet-api-debug t)
7576
#+END_SRC
7677

7778
* Usage
7879

7980
** Interactive Commands
8081

81-
| Command | Description | Key Binding |
82-
|----------------------------|--------------------------------|-------------|
83-
| =M-x pushbullet= | Open the Pushbullet Buffer | - |
84-
| =M-x pushbullet-send= | Send a note with prompted title and text | - |
85-
| =M-x pushbullet-send-text=| Send a note with prompted text | - |
86-
| =M-x pushbullet-region= | Send the current region | - |
87-
| =M-x pushbullet-yank= | Send clipboard contents | - |
88-
| =M-x pushbullet-update= | Update the Pushbullet buffer | =C-c C-u= |
82+
| Command | Description |
83+
|----------------------------+----------------------------------------------------------------------+
84+
| =M-x pushbullet= | Opens or switches to the main Pushbullet UI buffer. |
85+
| =M-x pushbullet-send= | Prompts for a title and text to send a new note push. |
86+
| =M-x pushbullet-send-text= | Prompts for text to send a new note push, using a default title. |
87+
| =M-x pushbullet-region= | Sends the active region's content as a note push. |
88+
| =M-x pushbullet-yank= | Sends the latest kill-ring entry (clipboard content) as a note push. |
89+
| =M-x pushbullet-export= | Exports currently fetched pushes to an Org-mode buffer. |
8990

9091
** Key Bindings in Pushbullet Buffer
9192

92-
| Key | Function |
93-
|----------|--------------------|
94-
| =C-c C-c=| Send a new push |
95-
| =C-c C-u=| Update/refresh the buffer |
96-
| =q= | Quit the buffer |
93+
| Key | Function |
94+
|-----------|--------------------------------------------|
95+
| =C-c C-e= | Export pushes to Org-mode. |
96+
| =C-c C-u= | Fetch more pushes. |
97+
| =C-c C-o= | Open a URL at the current cursor position. |
98+
| =q= | Close the Pushbullet buffer. |
9799

98100
** Examples
99101

@@ -119,61 +121,75 @@ A comprehensive Pushbullet client for GNU Emacs that allows you to send and mana
119121

120122
* API Reference
121123

122-
** Functions
124+
** Customization Variables
123125

124-
*** =pushbullet-send (title body)=
125-
Send a note to Pushbullet with the specified title and body text.
126+
*** =pushbullet-api-token=
127+
Your Pushbullet API access token (required).
126128

127-
*** =pushbullet-send-text (text)=
128-
Send a note with the default title and specified text.
129+
*** =pushbullet-api-limit=
130+
Number of pushes to fetch per request (default: =20=).
129131

130-
*** =pushbullet-region (start end)=
131-
Push the selected region to Pushbullet. The buffer name is used as the title.
132+
*** =pushbullet-default-title=
133+
Default title for pushes (default: ="GNU Emacs <version>"=).
132134

133-
*** =pushbullet-yank ()=
134-
Push the current kill-ring (clipboard) contents to Pushbullet.
135+
*** =pushbullet-columns=
136+
Maximum columns for text wrapping (default: =70=).
135137

136-
*** =pushbullet ()=
137-
Open the interactive Pushbullet UI buffer.
138+
*** =pushbullet-show-send-forms=
139+
Whether to display the send form in the Pushbullet UI, or not (default: =t=).
138140

139-
*** =pushbullet-update ()=
140-
Fetch and display the latest pushes in the current buffer.
141+
*** =pushbullet-debug=
142+
Enable debug logging (default: =nil=).
141143

142-
** Customization Variables
144+
*** =pushbullet-api-debug=
145+
Enable debug logging for the API requests (default: =nil=).
143146

144-
*** =pushbullet-token=
145-
Your Pushbullet API access token (required).
146147

147-
*** =pushbullet-limit=
148-
Number of pushes to fetch per request (default: 50).
148+
** Interactive Functions
149149

150-
*** =pushbullet-default-title=
151-
Default title for pushes (default: "GNU Emacs <version>").
150+
*** =(pushbullet)=
151+
Open the Pushbullet application buffer.
152152

153-
*** =pushbullet-columns=
154-
Maximum columns for text wrapping (default: 108).
153+
*** =(pushbullet-send title body &optional url)=
154+
Send a note to Pushbullet using the given title, message body, and, optionally, a URL.
155155

156-
*** =pushbullet-debug=
157-
Enable debug logging (default: nil).
156+
*** =(pushbullet-send-text text)=
157+
Send a note with the default title and specified text.
158+
159+
*** =(pushbullet-region start end)=
160+
Push the selected region to Pushbullet. The buffer name is used as the title.
161+
162+
*** =(pushbullet-yank)=
163+
Push the current kill-ring (clipboard) contents to Pushbullet.
164+
165+
*** =(pushbullet-export)=
166+
Export the list of Pushes to Org-Mode.
158167

159168
* Dependencies
160169

161-
This package requires the following Emacs packages:
170+
This package requires the following packages:
162171
- =emacs= ~(>= 29.1)~
163-
- =request= ~(>= 0.3.3)~
164172
- =all-the-icons= ~(>= 5.0.0)~
165-
- =auth-source= ~(>= 23.1)~
173+
- =request= ~(>= 0.3.3)~
174+
- =json= ~(>= 1.5)~
175+
- =auth-source= ~(>= 2.3.1)~
166176

167177
* License
168178

169179
This project is licensed under the GNU General Public License v3.0 - see the [[file:LICENSE][LICENSE]] file for details.
170180

171181
* Version
172182

173-
Current version: 1.0.0
183+
Current version: 1.0.1
174184

175185
* Changelog
176186

187+
** 1.1.1
188+
- New UI with new features and a form for submitting pushes
189+
- Deletion of a single push or all pushes at once
190+
- Export pushes to Org-Mode
191+
- Show image and files URLs
192+
177193
** 1.0.0
178194
- Initial release
179195
- Basic push sending functionality

0 commit comments

Comments
 (0)