Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
logseq-cldwalker committed Oct 28, 2022
1 parent 1dee36c commit 14f6006
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
## Description

This is a [github action](https://github.com/features/actions) to run validation
tests on a Logseq graph. Currently it tests to ensure queries and block refs are
valid. This action can catch errors that show up in the UI e.g.
`Invalid query`.
This is a [github action](https://github.com/features/actions) to run validation tests on a Logseq
graph. Currently it tests to ensure queries, block refs and properties are valid. This action can
catch errors that show up in the UI e.g. `Invalid query`.

## Usage

Expand Down Expand Up @@ -49,7 +48,9 @@ This action has the following inputs:

## Development

This github action use [nbb-logseq](https://github.com/logseq/nbb-logseq) and the [graph-parser library](https://github.com/logseq/logseq/tree/master/deps/graph-parser) to analyze a Logseq graph using its database and markdown AST data. This action is configured to run with yarn 3.X since the graph-parser library is depended on as a yarn workspace.
This github action use [nbb-logseq](https://github.com/logseq/nbb-logseq) and the [graph-parser
library](https://github.com/logseq/logseq/tree/master/deps/graph-parser) to analyze a Logseq graph
using its database and markdown AST data.

## Write your own Logseq action

Expand Down Expand Up @@ -84,9 +85,7 @@ $ yarn test /path/to/graph

To run this in another environment, clone this repo, install dependencies and
run tests. These steps are shown in the `action.yml` file. You can ignore the
caching steps which are specific to github. Be sure that the environment you're
running in supports yarn 3 as that is required in order to install dependencies.
This repo is configured to automatically run yarn 3 via the `.yarn*` files.
caching steps which are specific to github.

## LICENSE
See LICENSE.md
Expand Down

0 comments on commit 14f6006

Please sign in to comment.