Skip to content

Commit

Permalink
removed img and demo info
Browse files Browse the repository at this point in the history
  • Loading branch information
davidruvolo51 committed Sep 25, 2020
1 parent 98f343a commit fe13a49
Showing 1 changed file with 0 additions and 31 deletions.
31 changes: 0 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
![browsertools r package](browsertools.png)

<!-- badges: start -->
![version](https://img.shields.io/github/package-json/v/davidruvolo51/browsertools/prod?color=%2326709e)
Expand Down Expand Up @@ -67,33 +66,3 @@ The package offers the following functions.
| `show_elem` | `elem` | show an element
| `toggle_css` | `elem`, `css` | toggle a css class
| `toggle_elem` | `elem` | toggle the state of an element (i.e., hide or show)

### Demo

You can now view a demo of this package by running the following function.

```r
browsertools::run_demo()
```

## Development

If you would like to modify the package's js files, you will need to install the following tools.

1. [Node and Npm](https://nodejs.org/en/).
2. [Yarn](https://yarnpkg.com/getting-started/install)

This package also uses parceljs as the application bundler and a number of js packages. To install these tools, run the following command.

```bash
yarn install
```

To build javascript file, run the following command in the terminal.

```bash
yarn clean # removes existing files
yarn build # rebuilds js
```

Use the R script `dev/dev.R` for managing the package and the dev app for debugging/building new features.

0 comments on commit fe13a49

Please sign in to comment.