Skip to content

Commit

Permalink
Minor readme formatting/grammar corrections.
Browse files Browse the repository at this point in the history
  • Loading branch information
coddingtonbear committed Jul 26, 2021
1 parent 37be18a commit f650643
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 23 deletions.
30 changes: 8 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
## Obsidian CSV Table

Have data in a CSV file that you'd like to render as a table in Obsidian
now you can.
Have data in a CSV file that you'd like to render as a table in Obsidian? Now you can.

## Quickstart

Expand Down Expand Up @@ -73,18 +72,13 @@ will render a table like:

### Expressions

This library uses `filtrex` for expression evaluation;
see their documentation to see more information about the
expression syntax and what functions are available:
https://github.com/m93a/filtrex#expressions
This library uses `filtrex` for expression evaluation; see their documentation to see more information about the expression syntax and what functions are available: https://github.com/m93a/filtrex#expressions.

See "Filtering displayed rows" for an example of a filter expression
in action, but realistically they work exactly as you'd probably expect.
See "Filtering displayed rows" for an example of a filter expression in action, but realistically they work exactly as you'd probably expect.

### Selecting particular columns

You can use the `columns` field to control which columns of your CSV
file to render, e.g:
You can use the `columns` field to control which columns of your CSV file to render, e.g:

~~~
```csvtable
Expand Down Expand Up @@ -118,8 +112,7 @@ source: my_csv_file.csv
</tbody>
</table>

It's also possible for you to set better names for your columns or use
expressions:
It's also possible for you to set better names for your columns or use expressions:

~~~
```csvtable
Expand Down Expand Up @@ -157,8 +150,7 @@ source: my_csv_file.csv

### Filtering displayed rows

Maybe you would like to display only a subset of the rows of your CSV?
If so, you can provide a `filter` expression to limit which rows are shown:
Maybe you would like to display only a subset of the rows of your CSV? If so, you can provide a `filter` expression to limit which rows are shown:

~~~
```csvtable
Expand All @@ -182,11 +174,7 @@ filter: population < 100000000
</tbody>
</table>

By default, the parser will attempt to cast the values of each field
to an integer, boolean, or date object where appropriate for use
in your filter expressions.
Also, note that your filter expression can also be provided as a list;
those expressions will be and-ed together, e.g.:
By default, the parser will attempt to cast the values of each field to an integer, boolean, or date object where appropriate for use in your filter expressions. Also, note that your filter expression can also be provided as a list; those expressions will be and-ed together, e.g.:

~~~
```csvtable
Expand All @@ -197,6 +185,4 @@ filter:
```
~~~

Note that the filtering language requires that you use double-quoted
strings in comparisons -- if you had entered `name == 'Colombia'` above,
the filter would not have returned results.
Note that the filtering language requires that you use double-quoted strings in comparisons -- if you had entered `name == 'Colombia'` above, the filter would not have returned results.
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "obsidian-csv-table",
"name": "CSV Table",
"version": "1.0.2",
"version": "1.0.3",
"minAppVersion": "0.11.10",
"description": "Render CSV data as a table within your notes.",
"author": "Adam Coddington <me@adamcoddington.net>",
Expand Down
1 change: 1 addition & 0 deletions versions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"1.0.3": "0.11.10",
"1.0.2": "0.11.10",
"1.0.1": "0.11.10",
"1.0.0": "0.11.10",
Expand Down

0 comments on commit f650643

Please sign in to comment.