Skip to content
This repository was archived by the owner on Jun 10, 2021. It is now read-only.

Commit 69ea945

Browse files
committed
Added readme and license.
1 parent c9ad728 commit 69ea945

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

LICENSE.txt

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2016-2017 Richard Moore
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.
22+

README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Documentation
2+
=============
3+
4+
This is the documentation for the various Ethers projects.
5+
6+
The current projects documented here are:
7+
8+
- **ethers.js** - The Ethereum JavaScript library
9+
- **ethers-app** - The application library and toolchain for ethers.io and ethers.space.
10+
11+
**Coming soon:**
12+
13+
- **ethers.objc** - The Ethereum Objective-C library
14+
- **ethers.ino** - The Ethereum Arduino C library
15+
- **ethers-ens** - The ENS registration library and command-line tools
16+
- **ethers-build** - The testing, debugging and deployment library and tools; this is largely covered in the **ethers-app** documentation above, but this will be the low-level API for hacking into the framework
17+
18+
19+
Contributing
20+
------------
21+
22+
There is a little custom CSS involved, so if you are adding content,
23+
please observe the current formatting and naming conventions.
24+
25+
We will be quite picky when the documetation is being changed, but
26+
fully welcome it.
27+
28+
29+
License
30+
-------
31+
32+
MIT licensed.

0 commit comments

Comments
 (0)