Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
rohitkotian committed Feb 2, 2018
1 parent eced334 commit 65b9395
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,10 @@
# Change Log
All notable changes to this project will be documented in this file.

`web3swift` closely adheres to [Semantic Versioning](http://semver.org/).

---

## [0.0.8](https://github.com/MercuryProtocol/web3.swift/releases/tag/0.0.8) / 02nd'Feb 2018

* Initial commit to [github](https://github.com/MercuryProtocol/web3.swift).
10 changes: 5 additions & 5 deletions README.md
@@ -1,5 +1,5 @@
[![CocoaPods Compatible](https://img.shields.io/badge/pod-1.4.1-blue.svg)](https://img.shields.io/badge/pod-1.4.1-blue.svg)
[![Platform](https://img.shields.io/cocoapods/p/web3swift.svg?style=flat)](https://web3swift.github.io/web3swift)
[![Platform](https://img.shields.io/cocoapods/p/web3swift.svg?style=flat)](https://medium.com/@MercuryProtocol)
[![Twitter](https://img.shields.io/badge/twitter-@mecruryprotocol-blue.svg?style=flat)](https://twitter.com/mercuryprotocol)

web3.js utility library written in Swift.
Expand All @@ -26,13 +26,13 @@ Table of contents
- [x] Import Account
- [x] Create and Encode Transaction
- [x] Sign Transaction
- [x] [Complete Documentation](https://web3swift.github.io/web3swift)
- [x] ~~Complete Documentation~~

## Component Libraries

In order to keep web3swift focused specifically on core ethereum based utility functionality, additional component libraries will be created by the [Radical App LLC](https://github.com/web3swift/Foundation) to bring additional functionality to the mercury protocol ecosystem.

- [iOS Example App](https://git.cyberdust.com/sameer/web3SwiftExample.git) - Example showcasing use of web3swift library.
- ~~[iOS Example App](https://git.cyberdust.com/sameer/web3SwiftExample.git)~~ - Example showcasing use of web3swift library.
- [Mercury Wallet - Wallet App to use with mercury protocol. (Coming Soon)

## Requirements
Expand Down Expand Up @@ -128,8 +128,8 @@ web3swift is owned and maintained by the [Radical App LLC](http://www.mercurypro

## Contributors

* [Sameer Khavanekar](sameer@mercuryprotocol.com)
* [Rohit Kotian](rohit@mercuryprotocol.com)
* [Sameer Khavanekar](https://github.com/skhavanekar)
* [Rohit Kotian](https://github.com/roviko)

If you do want to participate please follow the [guideline](CONTRIBUTING.md).

Expand Down
4 changes: 4 additions & 0 deletions web3swift.xcodeproj/project.pbxproj
Expand Up @@ -26,6 +26,7 @@
42B0A8532011931800FE4872 /* web3swift.swift in Sources */ = {isa = PBXBuildFile; fileRef = 42B0A8522011931800FE4872 /* web3swift.swift */; };
8E986D6671B64E5ABDF7246F /* Pods_web3swiftTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = DD8A0192F629A5DABC806F64 /* Pods_web3swiftTests.framework */; };
B82E4D7EB970A99222F8ED9F /* Pods_web3swift.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B56EED7AF5E131285DFF2FD3 /* Pods_web3swift.framework */; };
CAB5C6AE2025249900E1A379 /* CHANGELOG.md in Resources */ = {isa = PBXBuildFile; fileRef = CAB5C6AD2025249900E1A379 /* CHANGELOG.md */; };
/* End PBXBuildFile section */

/* Begin PBXContainerItemProxy section */
Expand Down Expand Up @@ -64,6 +65,7 @@
42B0A84F2011865A00FE4872 /* LICENSE */ = {isa = PBXFileReference; lastKnownFileType = text; path = LICENSE; sourceTree = "<group>"; };
42B0A8522011931800FE4872 /* web3swift.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = web3swift.swift; sourceTree = "<group>"; };
B56EED7AF5E131285DFF2FD3 /* Pods_web3swift.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_web3swift.framework; sourceTree = BUILT_PRODUCTS_DIR; };
CAB5C6AD2025249900E1A379 /* CHANGELOG.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = CHANGELOG.md; sourceTree = "<group>"; };
DD8A0192F629A5DABC806F64 /* Pods_web3swiftTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_web3swiftTests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
ED2B068C99DC33C768476A47 /* Pods-web3swift.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-web3swift.debug.xcconfig"; path = "Pods/Target Support Files/Pods-web3swift/Pods-web3swift.debug.xcconfig"; sourceTree = "<group>"; };
FCCBD867E3A8461BD76E9BC2 /* Pods-web3swiftTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-web3swiftTests.release.xcconfig"; path = "Pods/Target Support Files/Pods-web3swiftTests/Pods-web3swiftTests.release.xcconfig"; sourceTree = "<group>"; };
Expand Down Expand Up @@ -202,6 +204,7 @@
42B0A851201186AD00FE4872 /* Documentation */ = {
isa = PBXGroup;
children = (
CAB5C6AD2025249900E1A379 /* CHANGELOG.md */,
4269083D201A9145009EFBB6 /* CONTRIBUTING.md */,
4226AD87201AC7D500C542C3 /* README.md */,
);
Expand Down Expand Up @@ -330,6 +333,7 @@
4269083E201A9145009EFBB6 /* CONTRIBUTING.md in Resources */,
42B0A8502011865A00FE4872 /* LICENSE in Resources */,
42B0A84B2011811000FE4872 /* web3swift.podspec in Resources */,
CAB5C6AE2025249900E1A379 /* CHANGELOG.md in Resources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down

0 comments on commit 65b9395

Please sign in to comment.