update README

yourtion · Dec 23, 2014 · 4fe54a2 · 4fe54a2
1 parent 956ebc3
commit 4fe54a2
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 112 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,44 @@ SuperLogger
 
 Save NSLog() to file and send email to developer
 
+## Installation
+
+The preferred way of installation is via CocoaPods. Just add
+
+```ruby
+pod 'SuperLogger'
+```
+
+and run pod install. It will install the most recent version of SuperLogger.
+
+## How to use
+
+Import the framework header on AppDelegate.m:
+
+```objective-c
+#import "SuperLogger.h"
+```
+
+Init and set email info:
+
+```objective-c
+SuperLogger *logger = [SuperLogger sharedInstance];
+// Start NSLogToDocument
+[logger redirectNSLogToDocumentFolder];
+// Set Email info
+logger.mailTitle = @"SuperLoggerDemo Logfile";
+logger.mailContect = @"This is the SuperLoggerDemo Logfile";
+logger.mailRecipients = @[@"yourtion@gmail.com"];
+```
+
+That's it! Have fun with SuperLogger!
+
+Show the Loglist by presentViewController "[[SuperLogger sharedInstance] getListView]" 
+
+```objective-c
+[self presentViewController:[[SuperLogger sharedInstance] getListView] animated:YES completion:nil];
+```
+
 ## ScreenShot
 
 ![ScreenShot1](ScreenShot/ScreenShot1.PNG)

diff --git a/SuperLogger.podspec b/SuperLogger.podspec
@@ -1,22 +1,7 @@
-#
-#  Be sure to run `pod spec lint SuperLogger.podspec' to ensure this is a
-#  valid spec and to remove all comments including this before submitting the spec.
-#
-#  To learn more about Podspec attributes see http://docs.cocoapods.org/specification.html
-#  To see working Podspecs in the CocoaPods repo see https://github.com/CocoaPods/Specs/
-#
-
 Pod::Spec.new do |s|
 
-  # ―――  Spec Metadata  ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
-  #
-  #  These will help people to find your library, and whilst it
-  #  can feel like a chore to fill in it's definitely to your advantage. The
-  #  summary should be tweet-length, and the description more in depth.
-  #
-
   s.name         = "SuperLogger"
-  s.version      = "0.2.0"
+  s.version      = "0.3.0"
   s.summary      = "Save NSLog() to file and send email to developer."
 
   s.description  = <<-DESC
@@ -29,108 +14,14 @@ Pod::Spec.new do |s|
                    DESC
 
   s.homepage     = "https://github.com/yourtion/SuperLogger"
-  # s.screenshots  = "www.example.com/screenshots_1.gif", "www.example.com/screenshots_2.gif"
-
-
-  # ―――  Spec License  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
-  #
-  #  Licensing your code is important. See http://choosealicense.com for more info.
-  #  CocoaPods will detect a license file if there is a named LICENSE*
-  #  Popular ones are 'MIT', 'BSD' and 'Apache License, Version 2.0'.
-  #
+  s.screenshots  = "https://raw.githubusercontent.com/yourtion/SuperLogger/master/ScreenShot/ScreenShot1.PNG", "https://raw.githubusercontent.com/yourtion/SuperLogger/master/ScreenShot/ScreenShot2.PNG", "https://raw.githubusercontent.com/yourtion/SuperLogger/master/ScreenShot/ScreenShot3.PNG"
 
   s.license      = "Apache License, Version 2.0"
-  # s.license      = { :type => "MIT", :file => "FILE_LICENSE" }
-
-
-  # ――― Author Metadata  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
-  #
-  #  Specify the authors of the library, with email addresses. Email addresses
-  #  of the authors are extracted from the SCM log. E.g. $ git log. CocoaPods also
-  #  accepts just a name if you'd rather not provide an email address.
-  #
-  #  Specify a social_media_url where others can refer to, for example a twitter
-  #  profile URL.
-  #
-
   s.author             = { "Yourtion" => "yourtion@gmail.com" }
-  # Or just: s.author    = "Yourtion"
-  # s.authors            = { "Yourtion" => "yourtion@gmail.com" }
-  # s.social_media_url   = "http://twitter.com/Yourtion"
-
-  # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
-  #
-  #  If this Pod runs only on iOS or OS X, then specify the platform and
-  #  the deployment target. You can optionally include the target after the platform.
-  #
-
   s.platform     = :ios
-  # s.platform     = :ios, "5.0"
-
-  #  When using multiple platforms
-  # s.ios.deployment_target = "5.0"
-  # s.osx.deployment_target = "10.7"
-
-
-  # ――― Source Location ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
-  #
-  #  Specify the location from where the source should be retrieved.
-  #  Supports git, hg, bzr, svn and HTTP.
-  #
-
-  s.source       = { :git => "https://github.com/yourtion/SuperLogger.git", :tag => "0.1.0" }
-
-
-  # ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
-  #
-  #  CocoaPods is smart about how it includes source code. For source files
-  #  giving a folder will include any h, m, mm, c & cpp files. For header
-  #  files it will include any header in the folder.
-  #  Not including the public_header_files will make all headers public.
-  #
-
+  s.source       = { :git => "https://github.com/yourtion/SuperLogger.git", :tag => "0.3.0" }
   s.source_files  = "SuperLogger"
-  #s.exclude_files = "Classes/Exclude"
-
-  # s.public_header_files = "Classes/**/*.h"
-
-
-  # ――― Resources ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
-  #
-  #  A list of resources included with the Pod. These are copied into the
-  #  target bundle with a build phase script. Anything else will be cleaned.
-  #  You can preserve files from being cleaned, please don't preserve
-  #  non-essential files like tests, examples and documentation.
-  #
-
-  # s.resource  = "icon.png"
-  # s.resources = "Resources/*.png"
-
-  # s.preserve_paths = "FilesToSave", "MoreFilesToSave"
-
-
-  # ――― Project Linking ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
-  #
-  #  Link your library with frameworks, or libraries. Libraries do not include
-  #  the lib prefix of their name.
-  #
-
   s.frameworks  = "Foundation", "UIKit", "MessageUI"
-  # s.frameworks = "SomeFramework", "AnotherFramework"
-
-  # s.library   = "iconv"
-  # s.libraries = "iconv", "xml2"
-
-
-  # ――― Project Settings ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
-  #
-  #  If your library depends on compiler flags you can set them in the xcconfig hash
-  #  where they will only apply to your library. If you depend on other Podspecs
-  #  you can include multiple dependencies to ensure it works.
-
   s.requires_arc = true
 
-  # s.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
-  # s.dependency "JSONKit", "~> 1.4"
-
 end