Skip to content

Commit

Permalink
review package.json(s) and README
Browse files Browse the repository at this point in the history
  • Loading branch information
KtorZ committed Dec 31, 2017
1 parent adb216e commit eb56207
Show file tree
Hide file tree
Showing 6 changed files with 1,566 additions and 730 deletions.
1 change: 0 additions & 1 deletion LICENSE.md → LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,3 @@
http://creativecommons.org/licenses/by-sa/4.0/

* All artwork randomly stolen from google image search so the license doesn't apply. Please let me know if any artwork is yours and I'll give credit or remove.

44 changes: 30 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,30 @@ This is a book on the functional paradigm in general. We'll use the world's most
That said, typed functional languages will, without a doubt, be the best place to code in the style presented by this book. JavaScript will be our means of learning a paradigm, where you apply it is up to you. Luckily, the interfaces are mathematical and, as such, ubiquitous. You'll find yourself at home with swiftz, scalaz, haskell, purescript, and other mathematically inclined environments.


### Gitbook (for a better reading experience)
## Read it Online

For a best reading experience, [read it online via Gitbook](https://drboolean.gitbooks.io/mostly-adequate-guide/content/).

- Quick-access side-bar
- In-browser exercises
- In-depth examples


## Download it

* [Read it online](https://drboolean.gitbooks.io/mostly-adequate-guide/content/)
* [Download PDF](https://www.gitbook.com/download/pdf/book/drboolean/mostly-adequate-guide)
* [Download EPUB](https://www.gitbook.com/download/epub/book/drboolean/mostly-adequate-guide)
* [Download Mobi (Kindle)](https://www.gitbook.com/download/mobi/book/drboolean/mostly-adequate-guide)

### Do it yourself

## Do it yourself

```
git clone https://github.com/DrBoolean/mostly-adequate-guide.git
cd mostly-adequate-guide/
npm install gitbook-cli -g
gitbook init
brew update
brew install Caskroom/cask/calibre
gitbook mobi . ./functional.mobi
npm install
npm run setup
gitbook pdf
```


Expand All @@ -64,6 +68,18 @@ See [FAQ.md](FAQ.md)

# Plans for the future

* **Part 1** (currently chapters 1-7) is a guide to the basics. I'm updating as I find errors since this is the initial draft. Feel free to help!
* **Part 2** (currently chapters 8+) will address type classes like functors and monads all the way through to traversable. I hope to squeeze in transformers and a pure application.
* **Part 3** will start to dance the fine line between practical programming and academic absurdity. We'll look at comonads, f-algebras, free monads, yoneda, and other categorical constructs.
* **Part 1** (chapters 1-7) is a guide to the basics. I'm updating as I find errors since this is the initial draft. Feel free to help!
* **Part 2** (chapters 8-10) will address type classes like functors and monads all the way through to traversable. I hope to squeeze in transformers and a pure application.
* **Part 3** (chapters 11+) will start to dance the fine line between practical programming and academic absurdity. We'll look at comonads, f-algebras, free monads, yoneda, and other categorical constructs.


---


<p align="center">
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
<img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" />
</a>
<br />
This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
</p>
58 changes: 42 additions & 16 deletions exercises/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 5 additions & 6 deletions exercises/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
{
"name": "mostly-adequate",
"name": "mostly-adequate-exercises",
"version": "1.0.0",
"description": "Exercises and examples for the Mostly Adequate Guide to Functional Programming",
"devDependencies": {
"cli": "^1.0.1",
"eslint": "^4.12.1",
"eslint-config-airbnb": "^16.1.0",
"eslint-plugin-import": "^2.8.0",
"eslint-plugin-jsx-a11y": "^6.0.2",
"eslint-plugin-react": "^7.5.1",
"live-server": "^1.2.0"
"live-server": "^1.2.0",
"mocha": "^4.1.0"
},
"scripts": {
"test": "mocha test/*.solutions.js",
Expand All @@ -30,8 +32,5 @@
"url": "https://github.com/MostlyAdequate/mostly-adequate-guide/issues"
},
"homepage": "https://github.com/MostlyAdequate/mostly-adequate-guide",
"dependencies": {
"cli": "^1.0.1",
"mocha": "^4.1.0"
}
"dependencies": {}
}
Loading

0 comments on commit eb56207

Please sign in to comment.