Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Karthikeya Udupa KM authored Oct 29, 2016
1 parent a33d008 commit da923e1
Showing 1 changed file with 3 additions and 11 deletions.
14 changes: 3 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Status](https://travis-ci.org/insanoid/SwiftyJSONAccelerator.svg?branch=master)]
- Modular code to make adding support for other JSON mapping libraries simple.
- Project upgraded with SwiftLint, Travis, CocoaPods etc.

[Download the .app (v1.0.0)](https://github.com/insanoid/SwiftyJSONAccelerator/releases/download/v1.0.0/SwiftyJSONAccelerator.zip)
## Download/Installing
- Download the repo, install pods and run the project!
- [Download the .app(v1.0.0)](https://github.com/insanoid/SwiftyJSONAccelerator/releases/download/v1.0.0/SwiftyJSONAccelerator.zip)

A swift model generator like the Objective-C [JSONAccelerator](http://nerdery.com/json-accelerator). Formats and generates models for the given JSON and also breaks them into files making it easy to manage and share between several models.

Expand All @@ -34,23 +36,17 @@ Currently, the pattern is very similar to its Objective-C counterpart. It genera

## Adding New Libraries

--------------------------------------------------------------------------------

- Add a new type in `JSONMappingLibrary` in [Constants.swift](SwiftyJSONAccelerator/Constants.swift).
- Follow the examples in [Library-Extensions](SwiftyJSONAccelerator/Library-Extensions) and create a struct implementing`ModelFile`. Follow the other extensions for SwiftyJSON and ObjectMapper, they tell you what all you can replace based on your libraries specification.
- Do the necessary UI changes for the dropdown.
- Add tests for your library.

## Swift 2?

--------------------------------------------------------------------------------

[Download (v0.0.6)](https://github.com/insanoid/SwiftyJSONAccelerator/releases/download/v0.0.6/SwiftyJSONAccelerator.zip), the older version of the project, please keep in mind it is **no longer supported**.

## Todo

--------------------------------------------------------------------------------

There is a lot more to do, follow the [issues section](https://github.com/insanoid/SwiftyJSONAccelerator/issues), I usually try to follow up or keep the list updated with any new ideas which I plan to implement.

- Build a CLI, useful in integrated with mocks and API documentations.
Expand All @@ -59,12 +55,8 @@ There is a lot more to do, follow the [issues section](https://github.com/insano

## Contributions and Requests

--------------------------------------------------------------------------------

Any suggestions regarding code quality of the app, generated code's quality, Swift related improvements and pull requests are all very welcome. Please make sure you submit the pull request to the next release branch and not the master branch.

## License

--------------------------------------------------------------------------------

[MIT License](LICENSE) / [Karthikeya Udupa](https://karthikeya.co.uk)

0 comments on commit da923e1

Please sign in to comment.