Skip to content

Commit

Permalink
Merge pull request #96 from chrishutchinson/chore/v3-readme-updates
Browse files Browse the repository at this point in the history
feat: v3 `README` updates
  • Loading branch information
chrishutchinson authored May 3, 2021
2 parents f096e85 + 875a411 commit ad6d05a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 124 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ CardKit has three main parts:

Additionally, a base class allows you to create your own renderers. See more in the [Custom Renderers](#custom-renderers) section.

**For version 1, see the [`v1-master`](https://github.com/chrishutchinson/cardkit/tree/v1-master) branch**

## Installation

`$ npm install cardkit --save`
Expand All @@ -22,6 +20,12 @@ CardKit requires a configuration object in order to render an image. Each render

In addition to these, you may also want to try the [CardKit Yeoman Generator](https://www.github.com/times/generator-cardkit), which can help you scaffold an entire project in just a few moments. It brings with it the latest version of CardKit, a recommended directory structure, and a build process that helps you get your CardKit project deployed. There is also a [JSFiddle](https://jsfiddle.net/chrishutchinson/16tLs2ta/) that you can fork and edit for quick in-browser testing without touching the command line.

### Previous versions

For **version 1**, see the [`v1-main`](https://github.com/chrishutchinson/cardkit/tree/v1-main) branch.

For **version 2**, see the [`v2-main`](https://github.com/chrishutchinson/cardkit/tree/v2-main) branch.

#### Yeoman generator

$ npm install -g yo generator-cardkit
Expand Down Expand Up @@ -264,13 +268,9 @@ var configuration = {
};
```

## Upgrading from v1.x

Upgrading from v1.x to v2 should be a fairly straightforward process if you haven't made any major modifications to the v1.x user interface. Your configuration object from v1.x should be compatible with v2 with a few minor tweaks. Specific variations are available in the Wiki.

## Running locally

CardKit currently requires Node.js 8, which you can install using `nvm` and running:
CardKit currently requires Node.js 14, which you can install using `nvm` and running:

$ nvm use

Expand Down
119 changes: 2 additions & 117 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ad6d05a

Please sign in to comment.