Skip to content

Commit 46c3834

Browse files
authored
Readme and contributing doc improvements (#1544)
* Update README.md * add preparing for release from readme * remove references badge
1 parent bad33e5 commit 46c3834

File tree

2 files changed

+19
-34
lines changed

2 files changed

+19
-34
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,24 @@ Check the Rakefile and the circleci config for more information.
3535

3636
#### 5. Make sure your code follows the [style guide](#style-guide)
3737

38+
### Preparing for a new release
39+
40+
#### Update the version number
41+
42+
You can use the rake task in order to bump the version number, it's safe, and will properly update all version numbers
43+
44+
```
45+
$ bundle exec rake package:set_version[X.X.X]
46+
```
47+
48+
Note that zsh users (such as those using macOS >= 10.15) need to escape the brackets as follows:
49+
50+
```
51+
$ bundle exec rake package:set_version\[X.X.X\]
52+
```
53+
54+
Replace X.X.X by the version number and push to the repository.
55+
3856
## Bugs
3957
Although we try to keep developing with the Parse Platform easy, you still may run into some issues. General questions should be asked on our [community forum](community-forum), technical questions should be asked on [Stack Overflow][stack-overflow], and for everything else we use GitHub issues.
4058

README.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,12 @@
1616
<a href=" https://github.com/parse-community/Parse-SDK-iOS-OSX/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-BSD-lightgrey.svg"></a>
1717
<a href="https://cocoapods.org/pods/Parse"><img alt="Podspec" src="https://img.shields.io/cocoapods/v/Parse.svg"></a>
1818
<a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/parse-server/backers/badge.svg" /></a>
19-
<a href="#sponsors"><img alt="Sponsors on Open Collective" src="https://opencollective.com/parse-server/sponsors/badge.svg" /></a>
19+
<a href="#sponsors"><img alt="Sponsors on Open Collective" src="https://opencollective.com/parse-server/sponsors/badge.svg" /></a>
2020
</p>
2121

2222
<p align="center">
2323
<a href="https://github.com/carthage/carthage"><img alt="Carthage compatible" src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat"></a>
2424
<a href="https://github.com/parse-community/Parse-SDK-iOS-OSX/blob/master/Vendor"><img alt="Dependencies" src="https://img.shields.io/badge/dependencies-2-yellowgreen.svg"></a>
25-
<a href="https://www.versioneye.com/objective-c/parse/references"><img alt="References" src="https://www.versioneye.com/objective-c/parse/reference_badge.svg"></a>
2625
<a href="https://travis-ci.org/parse-community/Parse-SDK-iOS-OSX/branches"><img alt="Build status" src="https://img.shields.io/travis/parse-community/Parse-SDK-iOS-OSX/master.svg"></a>
2726
<a href="https://circleci.com/build-insights/gh/parse-community/Parse-SDK-iOS-OSX/master"><img alt="Build status" src="https://circleci.com/gh/parse-community/Parse-SDK-iOS-OSX.svg?style=shield"></a>
2827
<a href="https://codecov.io/github/parse-community/Parse-SDK-iOS-OSX?branch=master"><img alt="Coverage status" src="https://img.shields.io/codecov/c/github/parse-community/Parse-SDK-iOS-OSX/master.svg"></a>
@@ -109,7 +108,6 @@ Compiled frameworks will be in multiple archives inside the `build/release` fold
109108
- `ParseTwitterUtils-iOS.zip`
110109
- `ParseUI.zip`
111110

112-
113111
#### Using Parse as a sub-project
114112

115113
You can also include parse as a subproject inside of your application if you'd prefer, although we do not recommend this, as it will increase your indexing time significantly. To do so, just drag and drop the Parse.xcodeproj file into your workspace. Note that unit tests will be unavailable if you use Parse like this, as OCMock will be unable to be found.
@@ -118,44 +116,13 @@ You can also include parse as a subproject inside of your application if you'd p
118116

119117
We want to make contributing to this project as easy and transparent as possible. Please refer to the [Contribution Guidelines][contributing].
120118

121-
## Preparing for a new release
122-
123-
### Update the version number
124-
125-
You can use the rake task in order to bump the version number, it's safe, and will properly update all version numbers
126-
127-
```
128-
$ bundle exec rake package:set_version[X.X.X]
129-
```
130-
131-
Note that zsh users (such as those using macOS >= 10.15) need to escape the brackets as follows:
132-
133-
```
134-
$ bundle exec rake package:set_version\[X.X.X\]
135-
```
136-
137-
Replace X.X.X by the version number and push to the repository.
138-
139119
## Dependencies
140120

141121
We use the following libraries as dependencies inside of Parse:
142122

143123
- [Bolts][bolts-framework], for task management.
144124
- [OCMock][ocmock-framework], for unit testing.
145125

146-
## License
147-
148-
```
149-
Copyright (c) 2015-present, Parse, LLC.
150-
All rights reserved.
151-
152-
This source code is licensed under the BSD-style license found in the
153-
LICENSE file in the root directory of this source tree. An additional grant
154-
of patent rights can be found in the PATENTS file in the same directory.
155-
```
156-
157-
As of April 5, 2017, Parse, LLC has transferred this code to the parse-community organization, and will no longer be contributing to or distributing this code.
158-
159126
[docs]: http://docs.parseplatform.org/ios/guide/
160127
[api]: http://parseplatform.org/Parse-SDK-iOS-OSX/api/
161128

0 commit comments

Comments
 (0)