Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Josip Brcina committed Nov 25, 2021
1 parent a598ab2 commit 3cb21f0
Showing 1 changed file with 21 additions and 42 deletions.
63 changes: 21 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,62 +7,41 @@
[changelog]: CHANGELOG.md
[version-badge]: https://img.shields.io/badge/version-0.1.0-blue.svg

- [Introduction](#introduction)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Coding Standards](#coding-standards)
- [Release Process](#release-process)
- [Versioning](#versioning)
- [Submission Guidelines](#submission-guidelines)
- [Local Run and Build](#local-run-and-build)

* [Branching Flow](#branching-flow)
* [Deployment](#deployment)

# NOTE: LJSP is not currently available for download. Coming soon!

## Introduction

`ljsp` provides utility functions to do abstract away common operations.
All utility functions are grouped. E.g. math, list, generic, object etc.
# LJSP: Embrace the Lisp in JavaScript!
Whether you agree that JavaScript is a Lisp or not, you can still harness the Lisp-inspired power of LJSP in your app. LJSP derives most of its functions from Clojure libraries. Clojurians will notice the extent to which we treated the Clojure docs not only as our requirements' specification, but as a great place to copy and paste text for our docs! For this, we offer heart-felt, tremendous thanks to the Clojure community.

For information on how to use LJSP, please visit our official documentation site:
[LJSP.org](https://www.ljsp.org)

## Getting Started

Clone from Git. Run `npm i`.

### Prerequisites

Make sure you have a standard, modern, FE development environment with `git`, and `node` installed and configured.
If you've followed the onboarding steps, you'll be setup correctly.
NPM `npm i ljsp-js`

### Release Process
YARN `yarn add ljsp-js`

Once a merge request is merged to master, github pipeline starts running. Once the pipeline finishes, you can see
the new version with changelog and other details in the release section of github project.
### USAGE

#### Versioning
```javascript
import { log, condp, str, mult, count, instance$ } from 'ljsp-js';

1. `ljsp` uses [semantic versioning][semantic-versioning].
2. `ljsp` follows [conventional commits][conventional-commits]. For list of scopes, see [Contributing Guideline](CONTRIBUTING.md).
3. Release happens automatically once the changes are merged to `master`.
log("Enter a number: ")
(function(line) {
log(
condp(eq, value,
1, "one",
2, "two",
3, "three",
str('unexpected value, "', value, '"')))
log(
condp(instance$, value,
Number, () => mult(value, 2),
String, () => mult(count(value), 2)))
})(Number(readLine()))
```

### Submission Guidelines

See the [CONTRIBUTING.md](CONTRIBUTING.md)

### Local Run and Build

As of today, building and testing locally is not integrated into the codebase. Please take advantage of
`RunJS` or use `any live editor` you want to test out your changes. We hope to bring in some dev loop here soon.

**Please test your changes thoroughly**.

## Branching Flow

We use the Release Flow methodology for our branching and release flow.

[semantic-versioning]: https://semver.org/spec/v2.0.0.html
[conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0/

0 comments on commit 3cb21f0

Please sign in to comment.