Spaces:
Sleeping
Sleeping
lukestanley
commited on
Commit
·
3e32321
1
Parent(s):
3ebb6e1
Documents command line usage and module import functionality
Browse files
README.md
CHANGED
@@ -6,7 +6,7 @@ This is an early experimental tool aimed at reducing online toxicity by automati
|
|
6 |
|
7 |
ChillTranslator aims to help make online interactions more healthy.
|
8 |
|
9 |
-
Currently, it "translates" a built-in example of a spicy comment.
|
10 |
|
11 |
Online toxicity can undermine the quality of discourse, causing distress 😞 and driving people away from online communities. Or worse: it can create a viral toxic loop 🌀!
|
12 |
|
@@ -70,6 +70,13 @@ ChillTranslator currently has an example spicy comment it works on fixing right
|
|
70 |
python3 chill.py
|
71 |
```
|
72 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
73 |
## Contributing 🤝
|
74 |
|
75 |
Contributions are welcome!
|
|
|
6 |
|
7 |
ChillTranslator aims to help make online interactions more healthy.
|
8 |
|
9 |
+
Currently, it "translates" a built-in example of a spicy comment, and it can be used via the command line to improve a specific text of your choice, or it can be imported as a module.
|
10 |
|
11 |
Online toxicity can undermine the quality of discourse, causing distress 😞 and driving people away from online communities. Or worse: it can create a viral toxic loop 🌀!
|
12 |
|
|
|
70 |
python3 chill.py
|
71 |
```
|
72 |
|
73 |
+
For improving a specific text of your choice, use the `-t` flag followed by your text enclosed in quotes:
|
74 |
+
```bash
|
75 |
+
python3 chill.py -t "Your text goes here"
|
76 |
+
```
|
77 |
+
|
78 |
+
Or chill can be imported as a module, with the improvement_loop function provided the text to improve.
|
79 |
+
|
80 |
## Contributing 🤝
|
81 |
|
82 |
Contributions are welcome!
|