Skip to content
This repository has been archived by the owner on Apr 3, 2019. It is now read-only.

Commit

Permalink
Litecoin: Update readme and package
Browse files Browse the repository at this point in the history
  • Loading branch information
@coblee
coblee committed Sep 2, 2016
1 parent c1c5279 commit 0a1eeb4
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 28 deletions.
51 changes: 26 additions & 25 deletions README.md
View file
@@ -1,29 +1,29 @@
Bitcore Library
Litecore Library
=======

[![NPM Package](https://img.shields.io/npm/v/bitcore-lib.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-lib)
[![Build Status](https://img.shields.io/travis/bitpay/bitcore-lib.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-lib)
[![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-lib.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-lib)
[![NPM Package](https://img.shields.io/npm/v/litecore-lib.svg?style=flat-square)](https://www.npmjs.org/package/litecore-lib)
[![Build Status](https://img.shields.io/travis/litecoin-project/litecore-lib.svg?branch=master&style=flat-square)](https://travis-ci.org/litecoin-project/litecore-lib)
[![Coverage Status](https://img.shields.io/coveralls/litecoin-project/litecore-lib.svg?style=flat-square)](https://coveralls.io/r/litecoin-project/litecore-lib)

A pure and powerful JavaScript Bitcoin library.
A pure and powerful JavaScript Litecoin library.

## Principles

Bitcoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin network allows for highly resilient bitcoin infrastructure, and the developer community needs reliable, open-source tools to implement bitcoin apps and services.
Litecoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Litecoin network allows for highly resilient litecoin infrastructure, and the developer community needs reliable, open-source tools to implement litecoin apps and services.

## Get Started

```
npm install bitcore-lib
npm install litecore-lib
```

```
bower install bitcore-lib
bower install litecore-lib
```

## Documentation

The complete docs are hosted here: [bitcore documentation](http://bitcore.io/guide/). There's also a [bitcore API reference](http://bitcore.io/api/) available generated from the JSDocs of the project, where you'll find low-level details on each bitcore utility.
The complete docs are hosted here: [litecore documentation](http://bitcore.io/guide/). There's also a [litecore API reference](http://bitcore.io/api/) available generated from the JSDocs of the project, where you'll find low-level details on each litecore utility.

- [Read the Developer Guide](http://bitcore.io/guide/)
- [Read the API Reference](http://bitcore.io/api/)
Expand All @@ -32,36 +32,36 @@ To get community assistance and ask for help with implementation questions, plea

## Examples

* [Generate a random address](https://github.com/bitpay/bitcore-lib/blob/master/docs/examples.md#generate-a-random-address)
* [Generate a address from a SHA256 hash](https://github.com/bitpay/bitcore-lib/blob/master/docs/examples.md#generate-a-address-from-a-sha256-hash)
* [Import an address via WIF](https://github.com/bitpay/bitcore-lib/blob/master/docs/examples.md#import-an-address-via-wif)
* [Create a Transaction](https://github.com/bitpay/bitcore-lib/blob/master/docs/examples.md#create-a-transaction)
* [Sign a Bitcoin message](https://github.com/bitpay/bitcore-lib/blob/master/docs/examples.md#sign-a-bitcoin-message)
* [Verify a Bitcoin message](https://github.com/bitpay/bitcore-lib/blob/master/docs/examples.md#verify-a-bitcoin-message)
* [Create an OP RETURN transaction](https://github.com/bitpay/bitcore-lib/blob/master/docs/examples.md#create-an-op-return-transaction)
* [Create a 2-of-3 multisig P2SH address](https://github.com/bitpay/bitcore-lib/blob/master/docs/examples.md#create-a-2-of-3-multisig-p2sh-address)
* [Spend from a 2-of-2 multisig P2SH address](https://github.com/bitpay/bitcore-lib/blob/master/docs/examples.md#spend-from-a-2-of-2-multisig-p2sh-address)
* [Generate a random address](https://github.com/litecoin-project/litecore-lib/blob/master/docs/examples.md#generate-a-random-address)
* [Generate a address from a SHA256 hash](https://github.com/litecoin-project/litecore-lib/blob/master/docs/examples.md#generate-a-address-from-a-sha256-hash)
* [Import an address via WIF](https://github.com/litecoin-project/litecore-lib/blob/master/docs/examples.md#import-an-address-via-wif)
* [Create a Transaction](https://github.com/litecoin-project/litecore-lib/blob/master/docs/examples.md#create-a-transaction)
* [Sign a Bitcoin message](https://github.com/litecoin-project/litecore-lib/blob/master/docs/examples.md#sign-a-bitcoin-message)
* [Verify a Bitcoin message](https://github.com/litecoin-project/litecore-lib/blob/master/docs/examples.md#verify-a-bitcoin-message)
* [Create an OP RETURN transaction](https://github.com/litecoin-project/litecore-lib/blob/master/docs/examples.md#create-an-op-return-transaction)
* [Create a 2-of-3 multisig P2SH address](https://github.com/litecoin-project/litecore-lib/blob/master/docs/examples.md#create-a-2-of-3-multisig-p2sh-address)
* [Spend from a 2-of-2 multisig P2SH address](https://github.com/litecoin-project/litecore-lib/blob/master/docs/examples.md#spend-from-a-2-of-2-multisig-p2sh-address)


## Security

We're using Bitcore in production, as are [many others](http://bitcore.io#projects), but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions.
We're using Litecore in production, as are [many others](http://bitcore.io#projects), but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions.

If you find a security issue, please email security@bitpay.com.

## Contributing

Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our [CONTRIBUTING](https://github.com/bitpay/bitcore-lib/blob/master/CONTRIBUTING.md) file.
Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our [CONTRIBUTING](https://github.com/litecoin-project/litecore-lib/blob/master/CONTRIBUTING.md) file.

## Building the Browser Bundle

To build a bitcore-lib full bundle for the browser:
To build a litecore-lib full bundle for the browser:

```sh
gulp browser
```

This will generate files named `bitcore-lib.js` and `bitcore-lib.min.js`.
This will generate files named `litecore-lib.js` and `litecore-lib.min.js`.

You can also use our pre-generated files, provided for each release along with a PGP signature by one of the project's maintainers. To get them, checkout a release commit (for example, https://github.com/bitpay/bitcore-lib/commit/e33b6e3ba6a1e5830a079e02d949fce69ea33546 for v0.12.6).

Expand All @@ -75,8 +75,8 @@ To verify signatures, use the following PGP keys:
## Development & Tests

```sh
git clone https://github.com/bitpay/bitcore-lib
cd bitcore-lib
git clone https://github.com/litecoin-project/litecore-lib
cd litecore-lib
npm install
```

Expand All @@ -91,6 +91,7 @@ or create a test coverage report (you can open `coverage/lcov-report/index.html`

## License

Code released under [the MIT license](https://github.com/bitpay/bitcore-lib/blob/master/LICENSE).
Code released under [the MIT license](https://github.com/litecoin-project/litecore-lib/blob/master/LICENSE).

Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.
Copyright 2016 The Litecoin Core Developers
11 changes: 8 additions & 3 deletions package.json
View file
@@ -1,7 +1,7 @@
{
"name": "bitcore-lib",
"name": "litecore-lib",
"version": "0.13.19",
"description": "A pure and powerful JavaScript Bitcoin library.",
"description": "A pure and powerful JavaScript Litecoin library.",
"author": "BitPay <dev@bitpay.com>",
"main": "index.js",
"scripts": {
Expand All @@ -11,6 +11,10 @@
"build": "gulp"
},
"contributors": [
{
"name": "Charlie Lee",
"email": "coblee@litecoin.org"
},
{
"name": "Daniel Cousens",
"email": "bitcoin@dcousens.com"
Expand Down Expand Up @@ -57,6 +61,7 @@
}
],
"keywords": [
"litecoin",
"bitcoin",
"transaction",
"address",
Expand All @@ -74,7 +79,7 @@
],
"repository": {
"type": "git",
"url": "https://github.com/bitpay/bitcore-lib.git"
"url": "https://github.com/litecoin-project/litecore-lib.git"
},
"browser": {
"request": "browser-request"
Expand Down

0 comments on commit 0a1eeb4

Please sign in to comment.