Skip to content

Commit

Permalink
📝 Few touch-ups to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
vcampitelli committed Oct 31, 2023
1 parent 1a681d0 commit a388313
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import { RemoteCode } from '@fusionauth/astro-components';
<RemoteCode lang="json" url="https://example.com/file.json"/>
```

This is equivalent of rendering a `<Code lang="json" code="..." />` with the contents of that JSON file.
This is equivalent to rendering a `<Code lang="json" code="..." />` with the contents of that JSON file.

### Props

Expand Down Expand Up @@ -100,7 +100,7 @@ use the `<RemoteValue>` component to render a specific value from that file.
### Usage

A simple usage example for the component (which will cover most cases) is when you have the following JSON file hosted
somewhere (e.g. GitHub) and you are writing a doc that mention that user.
somewhere (e.g. GitHub) and you are writing a doc that mentions that user.

```json
{
Expand Down Expand Up @@ -158,12 +158,12 @@ The `selector` can either be a `string` or a `function`.

##### Selector Strings

When using `string`, you need to check the specific documentation for the parser we use. As we only have JSON right now,
When using selector strings, you need to check the specific documentation for the parser we use. As we only have JSON right now,
please check [`jsonpath-plus`](https://www.npmjs.com/package/jsonpath-plus), which implements an XPath-based syntax.

##### Selector Functions

When using `function`, we'll pass the parsed file (e.g. the JSON object) as an argument and the function should return
When using selector functions, we'll pass the parsed file (e.g. the JSON object) as an argument and the function should return
the value.

##### Selector Examples
Expand Down Expand Up @@ -217,6 +217,15 @@ Rendering inside inline backticks won't work, but you can use standard `<code>`
<code><RemoteValue url="..." /></code>
```

## Contributing

Bug reports and pull requests are welcome on GitHub.

## License

This code is available as open source under the terms of the [Apache v2.0 License](https://opensource.org/licenses/Apache-2.0).

## Support

This is created and maintained with love by [FusionAuth](https://fusionauth.io), the customer authentication and
authorization platform that makes developers' lives awesome.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@fusionauth/fusionauth-astro-components",
"version": "0.0.1",
"description": "Component to fetch code from an external URI",
"description": "Set of Astro components to improve the developer experience when writing pages",
"type": "module",
"exports": {
".": "./index.ts"
Expand Down

0 comments on commit a388313

Please sign in to comment.