add a Readme and update copyright

This commit is contained in:
Sami Samhuri 2014-03-30 22:30:48 -07:00
parent a1e5adf606
commit d1c987ae38
15 changed files with 75 additions and 14 deletions

View file

@ -237,7 +237,7 @@
isa = PBXProject;
attributes = {
LastUpgradeCheck = 0430;
ORGANIZATIONNAME = "Guru Logic";
ORGANIZATIONNAME = "Sami Samhuri";
};
buildConfigurationList = 7BE32D0014132EE3008F2DEA /* Build configuration list for PBXProject "Marshmallows" */;
compatibilityVersion = "Xcode 3.2";

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-03.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import <UIKit/UIImage.h>

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-03.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import "MMHTTPClient.h"

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-03.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import <Foundation/Foundation.h>

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-03.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import "MMHTTPRequest.h"

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-03.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import <Foundation/Foundation.h>

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-03.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import <Foundation/Foundation.h>

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-03.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import "NSString+marshmallows.h"

View file

@ -3,7 +3,7 @@
// DatingX
//
// Created by Sami Samhuri on 11-08-24.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import <UIKit/UIKit.h>

View file

@ -3,7 +3,7 @@
// DatingX
//
// Created by Sami Samhuri on 11-08-24.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import "UIAlertView+marshmallows.h"

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-05.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import <Foundation/Foundation.h>

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-05.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import "UIAlertViewDelegate.h"

View file

@ -3,7 +3,7 @@
// Marshmallows
//
// Created by Sami Samhuri on 11-09-04.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import <GHUnitIOS/GHUnit.h>

View file

@ -3,7 +3,7 @@
// MarshmallowsTesting
//
// Created by Sami Samhuri on 11-09-04.
// Copyright 2011 Guru Logic. All rights reserved.
// Copyright 2011 Sami Samhuri. All rights reserved.
//
#import <UIKit/UIKit.h>

61
Readme.md Normal file
View file

@ -0,0 +1,61 @@
# Marshmallows
Marshmallows sweeten up your Cocoa for iOS.
## Overview
Sometimes the simple things are verbose with Cocoa. This project aims
to make the simple things less verbose. Mainly via categories, but this
may change. Or prefixes to each method name might be added.
## Installation
Marshmallows is available on CocoaPods, add `pod 'Marshmallows', '~> 0.1'` to your Podfile.
Alternatively you could clone this repo and add the files you want into your project directly.
## Categories
### NSDate
- Adds `+[NSDate dateWithYear:month:day:]` to construct a date
- Adds `-[NSDate relativeToNow]` to get a string describing the date, e.g. 1 minute ago
### NSString
- Adds `-[NSString firstMatch:]` to find the first substring matching the given regex string.
- Adds `-[NSString stringByReplacing:with:]` to replace all occurrences of the given regex string with something.
- Adds `-[NSString stringByReplacingFirst:with:]` to replace one occurrence of the given regex string with something.
- Adds `-[NSString stringByTrimmingWhitespace]` to trim strings.
- Adds `-[NSString stringByURLEncoding]` encodes a string for use in a URL, including ampersands (and others).
### UIAlertView
The last argument to the confirm methods is a block with the signature `^(int buttonClicked, BOOL canceled)`.
- Adds `+[UIAlertView showAlertWithTitle:message:]`.
- Adds `+[UIAlertView confirmWithTitle:message:then:]`.
- Adds `+[UIAlertView confirmWithTitle:message:cancelTitle:okTitle:then:]`.
## Classes
### MMHTTPClient
Provides a simple HTTP client built on `MMHTTPRequest`. Makes it trivial to fetch some text or an image.
(JSON is coming!)
### MMHTTPRequest
A simple HTTP request class that uses blocks. It can decode text and image responses. (JSON is coming!)
# License
&copy; 2011-2014 Sami Samhuri <sami@samhuri.net>
[MIT license](http://sjs.mit-license.org)