danielrosehill commited on
Commit
55ce835
·
1 Parent(s): 01517da

Add example input/output files and JSON representation

Browse files

- Add example/input.md with sample email text
- Add example/output.md with BLUF formatted version
- Add example/output.json with structured JSON format
- Complete project with working examples for users

Files changed (4) hide show
  1. README.md +2 -0
  2. example/input.md +30 -0
  3. example/output.json +8 -0
  4. example/output.md +40 -0
README.md CHANGED
@@ -11,6 +11,8 @@ pinned: false
11
 
12
  # 📧 BLUF Email Formatter
13
 
 
 
14
  A Gradio-based Hugging Face Space that transforms draft emails into clear, actionable communication using the **Bottom Line Up Front (BLUF)** methodology.
15
 
16
  [Learn more about BLUF](https://hbr.org/2016/11/how-to-write-email-with-military-precision).
 
11
 
12
  # 📧 BLUF Email Formatter
13
 
14
+ ![alt text](screenshots/1.png)
15
+
16
  A Gradio-based Hugging Face Space that transforms draft emails into clear, actionable communication using the **Bottom Line Up Front (BLUF)** methodology.
17
 
18
  [Learn more about BLUF](https://hbr.org/2016/11/how-to-write-email-with-military-precision).
example/input.md ADDED
@@ -0,0 +1,30 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Hi Hannah,
2
+
3
+ I was thinking about the conference call yesterday.
4
+
5
+ Some thoughts:
6
+
7
+ - Do you still want to go ahead with the email signature idea? If so, I would recommend sending it out for design today.
8
+
9
+ The typical format would be a call to action with the shortlink.
10
+
11
+ However ... as we're looking at publishing two editions (on Amazon UK and US) I would actuallly recommend that we link to a short link tree which I would be happy to create.
12
+
13
+ These are basically slim landing pages with buttons linking on to individaul assets.
14
+
15
+ If so, I can implement any variations on this theme:
16
+
17
+ book.hannah.com
18
+ hannah.com/buy-book
19
+
20
+ Etc
21
+
22
+ Let me know your preferences and I can get a wireframe over to you later.
23
+
24
+ Best,
25
+
26
+ Daniel
27
+
28
+
29
+
30
+
example/output.json ADDED
@@ -0,0 +1,8 @@
 
 
 
 
 
 
 
 
 
1
+ [
2
+ {
3
+ "subject": "DECISION: Choose Approach for Email Signature and Shortlink",
4
+ "bluf_tag": "DECISION:",
5
+ "bluf_summary": "We need to decide on the email signature design and the shortlink structure for the two editions of the book. Options include a call to action with a shortlink or a shortlink tree leading to individual assets.",
6
+ "email": "Bottom Line Up Front\n\nPurpose: DECISION:\n\nWe need to decide on the email signature design and the shortlink structure for the two editions of the book. Options include a call to action with a shortlink or a shortlink tree leading to individual assets.\n\nHi Hannah,\n\nI was thinking about the conference call yesterday. \n\nSome thoughts:\n\n- Do you still want to go ahead with the email signature idea? If so, I would recommend sending it out for design today. \n\nThe typical format would be a call to action with the shortlink.\n\nHowever ... as we're looking at publishing two editions (on Amazon UK and US) I would actuallly recommend that we link to a short link tree which I would be happy to create. \n\nThese are basically slim landing pages with buttons linking on to individaul assets. \n\nIf so, I can implement any variations on this theme:\n\nbook.hannah.com\nhannah.com/buy-book\n\nEtc\n\nLet me know your preferences and I can get a wireframe over to you later.\n\nBest,\n\nDaniel"
7
+ }
8
+ ]
example/output.md ADDED
@@ -0,0 +1,40 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ DECISION: Choose Approach for Email Signature and Shortlink
2
+
3
+ Bottom Line Up Front
4
+
5
+ Purpose: DECISION:
6
+
7
+ We need to decide on the email signature design and the shortlink structure for the two editions of the book. Options include a call to action with a shortlink or a shortlink tree leading to individual assets.
8
+
9
+ Hi Hannah,
10
+
11
+ I was thinking about the conference call yesterday.
12
+
13
+ Some thoughts:
14
+
15
+ - Do you still want to go ahead with the email signature idea? If so, I would recommend sending it out for design today.
16
+
17
+ The typical format would be a call to action with the shortlink.
18
+
19
+ However ... as we're looking at publishing two editions (on Amazon UK and US) I would actuallly recommend that we link to a short link tree which I would be happy to create.
20
+
21
+ These are basically slim landing pages with buttons linking on to individaul assets.
22
+
23
+ If so, I can implement any variations on this theme:
24
+
25
+ book.hannah.com
26
+ hannah.com/buy-book
27
+
28
+ Etc
29
+
30
+ Let me know your preferences and I can get a wireframe over to you later.
31
+
32
+ Best,
33
+
34
+ Daniel
35
+
36
+ BLUF Section:
37
+
38
+ Tag: DECISION:
39
+
40
+ We need to decide on the email signature design and the shortlink structure for the two editions of the book. Options include a call to action with a shortlink or a shortlink tree leading to individual assets.