Skip to content

Commit

Permalink
📝 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AnandChowdhary committed Apr 18, 2019
1 parent 13a39ba commit 9858d0c
Showing 1 changed file with 6 additions and 54 deletions.
60 changes: 6 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,15 @@
# 📦 strotate
# 🔄 Strotate

[![Travis CI](https://img.shields.io/travis/AnandChowdhary/strotate.svg)](https://travis-ci.org/AnandChowdhary/strotate)
[![Coverage Status](https://coveralls.io/repos/github/AnandChowdhary/strotate/badge.svg?branch=master)](https://coveralls.io/github/AnandChowdhary/strotate?branch=master)
[![GitHub](https://img.shields.io/github/license/anandchowdhary/strotate.svg)](https://github.com/AnandChowdhary/strotate/blob/master/LICENSE)
![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/AnandChowdhary/strotate.svg)
[![Minzipped size](https://img.shields.io/bundlephobia/minzip/strotate.svg)](https://www.npmjs.com/package/strotate)

strotate is a web/DOM library starter with these features:

- [x] Written in Typescript
- [x] Built-in demo with GitHub pages (`./docs/` folder)
- [x] main/module/types in `package.json`
- [x] Bundled as UMD (works as a module)
- [x] Exposes `window.Library` (works with CDNs)
- [x] Style with Sass
- [x] Test with Jest
- [x] Build with Travis CI
- [x] Clean with Prettier
Rotate your strings with Strotate.

## ⭐ Getting started

Clone and start your project:

```bash
git clone git@github.com:AnandChowdhary/strotate
mv strotate my-library && cd my-library
sudo rm -r .git && git init
```

Find and replace "strotate" with your library name and "AnandChowdhary" with your GitHub username.

### GitHub configuration

Setup GitHub Pages demo by going to Settings → GitHub Pages → Source → master branch /docs folder.

### Development

Start development server with HMR and prettier:

```bash
yarn start
```

### Production

Build a production version:

```bash
yarn build
```

## 🛠️ Using a strotate library

Install the library as a dependency:

```bash
Expand All @@ -64,16 +22,16 @@ Or, if you're using Yarn:
yarn add strotate
```

Then import the library:
Then import functions:

```js
import strotate from "strotate";
import { rot13, unRot13 } from "strotate";
```

And initialize it with an optional selector:
And start using it:

```js
const strotate = new strotate("#heading");
const rotated = rot13("Hello!");
```

You can also use a CDN:
Expand All @@ -82,12 +40,6 @@ You can also use a CDN:
<script src="https://unpkg.com/strotate"></script>
```

## 💡 Why another starter?

I've used a bunch of different Typescript library starters, but they all have tons of boilerplate (super long build rules, scripts for releases, publishing, building, etc.)

strotate is—like the name suggests—a starting point.

## 📝 License

Unlicense (public domain, do whatever you want)

0 comments on commit 9858d0c

Please sign in to comment.