Skip to content

Commit

Permalink
Add Project Logo
Browse files Browse the repository at this point in the history
  • Loading branch information
christianechevarria committed Apr 17, 2019
1 parent 79173f3 commit c383389
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 35 deletions.
82 changes: 47 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,43 @@
# Carrot™
>A Simple Node.js AI Library for Neural Network
[![Build Status via Travis CI](https://travis-ci.org/liquidcarrot/carrot.svg?branch=master)](https://travis-ci.org/liquidcarrot/carrot)
[![Carrot's Weekly Download](https://img.shields.io/npm/dm/@liquid-carrot/carrot.svg)](https://www.npmjs.com/package/@liquid-carrot/carrot)
[![Coverage Status](https://coveralls.io/repos/github/liquidcarrot/carrot/badge.svg?branch=master)](https://coveralls.io/github/liquidcarrot/carrot?branch=master)
[![Join the chat at https://gitter.im/carrot-ai/community](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/carrot-ai/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badgee&utm_content=badge)
[![Carrot's License](https://img.shields.io/badge/License-MIT-blue.svg)](/LICENSE)
[![Carrot's Love](https://img.shields.io/badge/Made%20with%20%E2%99%A5%20by-Liquid%20Carrot-ff1414.svg)](https://github.com/liquidcarrot/carrot/issues)
<p align="center">
<img src="https://raw.githubusercontent.com/liquidcarrot/carrot/master/logo/carrot-logo_readme.png" alt="Carrot Logo"/>
</p>

<p align="center">
<a href="https://travis-ci.org/liquidcarrot/carrot">
<img src="https://travis-ci.org/liquidcarrot/carrot.svg?branch=master"
alt="Build Status via Travis CI">
</a>
<a href="https://www.npmjs.com/package/@liquid-carrot/carrot">
<img src="https://img.shields.io/npm/dm/@liquid-carrot/carrot.svg"
alt="Carrot's Monthly Downloads">
</a>
<a href="https://coveralls.io/github/liquidcarrot/carrot?branch=master">
<img src="https://coveralls.io/repos/github/liquidcarrot/carrot/badge.svg?branch=master"
alt="Coverage Status">
</a>
<a href="https://gitter.im/carrot-ai/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badgee&utm_content=badge">
<img src="https://badges.gitter.im/Join%20Chat.svg"
alt="Join the chat at https://gitter.im/carrot-ai/community">
</a>
<a href="/LICENSE">
<img src="https://img.shields.io/badge/License-MIT-blue.svg"
alt="Carrot's License">
</a>
<a href="https://github.com/liquidcarrot/carrot/issues">
<img src="https://img.shields.io/badge/Made%20with%20%E2%99%A5%20by-Liquid%20Carrot-ff1414.svg"
alt="Made with love">
</a>
</p>

<p>
Carrot is a flexible neural network AI Library for Node.js with neuro-evolution capabilities</h2>
</p>

For Documentation, visit [https://liquidcarrot.github.io/carrot](https://liquidcarrot.github.io/carrot)

<details>
<summary><strong>Table of Contents</strong></summary>

* [Contributing](#contributing)
* [Support](#support)
* [Contributors](#contributors)
* [Documentation](/DOCUMENTATION.md)
</details>

## Install

```bash
$ npm i @liquid-carrot/carrot
```
## Getting Started

Carrot files are hosted by GitHub Pages, just copy this link into the `<head>` tag:

```html
<script src="https://liquidcarrot.io/carrot/cdn/0.1.72/carrot.js"></script>
```

### Introduction

Making your first neuron.
Making neurons

```javascript
let Node = require('@liquid-carrot/carrot').Node
Expand All @@ -46,17 +50,25 @@ A.activate(0.5)
console.log(B.activate())
```

Making your first neural network.
Making neural networks

```javascript
let Network = require('@liquid-carrot/carrot').Network

let network = new Network([2, 2, 1]) // Builds a neural network with 5 neurons: 2 + 2 + 1
```

## Built With
## Install

* [Lodash](https://lodash.com/) - A JavaScript utility library
```bash
$ npm i @liquid-carrot/carrot
```

Carrot files are hosted by GitHub Pages, just copy this link into the `<head>` tag:

```html
<script src="https://liquidcarrot.io/carrot/cdn/0.1.72/carrot.js"></script>
```

## Contributing
[![Carrot's GitHub Issues](https://img.shields.io/github/issues/liquidcarrot/carrot.svg)](https://github.com/liquidcarrot/carrot/issues)
Expand Down
Binary file added logo/carrot-logo_readme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c383389

Please sign in to comment.