Skip to content

Commit

Permalink
Added Lamington logo to Readme. Let editor auto-format markdown. Fixe…
Browse files Browse the repository at this point in the history
…d a typo.
  • Loading branch information
thekevinbrown committed Apr 24, 2019
1 parent e391e8e commit 7acce16
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# Lamington
<p align="center">
<img src="https://lamington.io/logo.svg" alt="Lamington Logo" width="300"/>
</p>

Inspired by the popular Truffle framework and developed in Typescript, Lamington makes smart contract development simple for any level of EOSIO developer.

## Features

The Lamington library includes CLI tools and JavaScript utilities to streamline the smart contract building, testing and deployment pipeline.

* Skill level agnostic
* TypeScript ready
* Containerized development
* Common JavaScript testing frameworks
* Multi-environment support
* Simple CLI commands
* Easily configurable
- Skill level agnostic
- TypeScript ready
- Containerized development
- Common JavaScript testing frameworks
- Multi-environment support
- Simple CLI commands
- Easily configurable

## Installation

Lamington includes command line tools and JavaScript utilities for EOSIO contract development. If you haven't installed Lamington as a global dependency already, we recommend doing so with;

```
Expand All @@ -28,9 +33,11 @@ npm install --save-dev lamington
```

## Usage
Lamington is super simple! Whether your migrating from Solidity, or a seasoned EOSIO developer deploying a complex Decentralized Application.

Lamington is super simple! Whether you're migrating from Solidity, or a seasoned EOSIO developer deploying a complex Decentralized Application.

### Building

Compiling your smart contracts with Lamington is as simple as;

```
Expand All @@ -40,16 +47,18 @@ lamington build
Lamington automatically searches for all files with the `.cpp` file extension before batch compiling within a docker container. Compiling within a docker container with locked configuration ensures contracts compile consistently and clean every time.

#### Ignoring Files & Folders

Fortunately we realized that not every `.cpp` file is a build ready contract. So we added an additional ignore file, rightly named `.lamingtonignore`, to configure directories, files and patterns you don't want added to your build process. The `.lamingtonignore` follows the same syntax as a standard `.gitignore`, requiring a line separated list of ignore definitions. We've added the command line method `lamington ignore` to generate a `.lamingtonignore` file with default settings.

#### Specifying Build Contracts

If you'd like to run builds on specific contracts, an additional contract `identifier` can be specified like so;

```
lamington build [identifier]
```

*Replacing the `[identifier]` with your contract name, filename or fullpath.*
_Replacing the `[identifier]` with your contract name, filename or fullpath._

### Testing

Expand All @@ -58,6 +67,7 @@ lamington test
```

## Configuration

Lamington ships with a default configuration to make getting started simple and setup free. However, as your project grows, so will the need for additional Lamington configuration. For example, deployment to a testnet or the live network will require environment setup. Additionally, you'll need customize your configuration if you'd like to control Lamington's fine grain settings. Fortunately we've made it easy to get started with a simple boilerplate generation method;

```
Expand All @@ -67,10 +77,12 @@ lamington init
This creates a `.lamingtonrc` file in your current directory. The `.lamingtonrc` file allows you to configure additional settings using JSON syntax.

### Using a Configuration File
* Configuring environments
* keepAlive

- Configuring environments
- keepAlive

## Resources

You can find more information about the Lamington tool-set and join our growing community of developers by visiting any of the following links;

[API Documentation](https://docs.lamington.dev)
Expand All @@ -88,7 +100,8 @@ You can find more information about the Lamington tool-set and join our growing
### Lamington-Angular

## Contributors
*Contribution guide*

_Contribution guide_
[Kevin Brown](https://github.com/thekevinbrown), Creator & Developer
[Mitch Pierias](https://github.com/MitchPierias), Developer

Expand Down

0 comments on commit 7acce16

Please sign in to comment.