8000 Misc documentation and README cleanup. · Synthoid/ExportSheetData@adb3907 · GitHub
[go: up one dir, main page]
Skip to content

Commit adb3907

Browse files
SynthoidSynthoid
committed
Misc documentation and README cleanup.
1 parent 2a3c93e commit adb3907

File tree

2 files changed

+28
-22
lines changed

2 files changed

+28
-22
lines changed

‎README.md‎

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,48 +14,54 @@ Install
1414

1515
Export Sheet Data is available on the Google Workspace Marketplace.
1616

17-
**NOTE:** There is a known bug when using add-ons while multiple accounts are signed in. If you run into a situation where the ESD sidebar doesn't seem to load, visit the [troubleshooting](docs/troubleshooting.md) page for help.
18-
19-
Frequently Asked Questions
20-
--------------------------
21-
You can see answers to frequently asked questions about ESD [here](docs/faq.md).
17+
> [!WARNING]
18+
> There is a known bug that can affect add-ons while multiple accounts are signed in. If you run into a situation where the ESD sidebar doesn't seem to load, visit the [troubleshooting](docs/troubleshooting.md) page for help.
2219
2320
Documentation
2421
-------------
2522
[Documentation index page](https://github.com/Synthoid/ExportSheetData/blob/master/docs/index.md)
2623

27-
The best way to figure out how to use Export Sheet Data is by opening the sidebar, reading the tooltips of various options and experimenting with the output using the Visualize option.
24+
The best way to learn how to use Export Sheet Data is by using it! Open the sidebar, read the tooltips of various seettings, and experiment by using the Visualize option.
2825

29-
For detailed documentation on each option, take a look at the documentation.
26+
For detailed documentation on each option, take a look at ESD's documentation.
3027

3128
If you want to create more advanced data structures, make sure to read the Wiki page about [Nested Elements](https://github.com/Synthoid/ExportSheetData/wiki/Nested-Elements).
3229

3330
Troubleshooting
3431
---------------
35-
If you ever experience an issue or have difficulty using ESD, you can look at the [toubleshooting](docs/troubleshooting.md) page for help. This page contains solutions for common issues you may encounter, especially for the more complex features of ESD. If you notice anything the troubleshooting page does not cover, feel free to make a new issue to help improve ESD!
32+
If you ever experience an issue or have difficulty using ESD, you can look at the [toubleshooting](docs/troubleshooting.md) page for help. This page contains solutions for common issues you may encounter, especially for the more complex features of ESD.
33+
34+
If you notice anything the troubleshooting page does not cover, feel free to make a new issue to help improve ESD!
35+
36+
Frequently Asked Questions
37+
--------------------------
38+
You can see answers to frequently asked questions about ESD [here](docs/faq.md).
3639

3740
Development Status
3841
------------------
3942
Export Sheet Data supports a wide variety of features. Currently, this includes:
4043

4144
**JSON**
42-
* Forcing all data to string values
43-
* Exporting individual cells as JSON arrays
44-
* Exporting a sheet's contents as an array of JSON objects
45-
* Creating complex data structures via Nested Elements
45+
* Force all data to string values
46+
* Export individual cells as JSON objects or arrays
47+
* Export a sheet's contents as an array of JSON objects
48+
* Create complex data structures via Nested Elements
4649

4750
**XML**
48-
* Exporting columns as attributes, child elements, or inner text of a row
51+
* Export columns as attributes, child elements, or inner text of a row's element
4952
* Automatic formatting of XML illegal characters like `&`, `<`, and `>`
50-
* Exporting booleans as integers
5153
* XML comments and declaration support
5254
* XML namespaces
5355

5456
**General**
55-
* Visualize data before exporting
56-
* Exporting specific sheets
57-
* Unwrapping or collapsing a sheet's data for easier access after exporting
58-
* Minifying exported data to produce smaller files
57+
* Visualize data
58+
* Export files to Drive
59+
* Replace target Drive file contents
60+
* Download files directly
61+
* Export specific sheets
62+
* Unwrap or collapse a sheet's data for easier access after exporting
63+
* Minify exported data to produce smaller files
64+
* Export booleans as integers
5965

6066
Contributing
6167
------------

‎docs/json/exportsheetarrays.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Export sheet arrays will export sheets as JSON arrays with each row creating an
1111

1212
Name | Console
1313
---- | -------
14-
Microsoft | Xbox One
14+
Microsoft | Xbox Series X
1515
Nintendo | Switch
16-
Sony | Playstation 4
16+
Sony | Playstation 5
1717

1818
*Default Output:*
1919
```json
@@ -38,15 +38,15 @@ Sony | Playstation 4
3838
"Companies": [
3939
{
4040
"Name": "Microsoft",
41-
"Console": "Xbox One"
41+
"Console": "Xbox Series X"
4242
},
4343
{
4444
"Name": "Nintendo",
4545
"Console": "Switch"
4646
},
4747
{
4848
"Name": "Sony",
49-
"Console": "Playstation 4"
49+
"Console": "Playstation 5"
5050
}
5151
]
5252
}

0 commit comments

Comments
 (0)
0