Skip to content
This repository has been archived by the owner on Feb 20, 2025. It is now read-only.

Commit

Permalink
refactor: added readme and boilerplate
Browse files Browse the repository at this point in the history
  • Loading branch information
akshaybhalotia committed Oct 22, 2021
1 parent 0742b4d commit f790ea5
Show file tree
Hide file tree
Showing 5 changed files with 219 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- 0.1
- Initial release
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

All Dyte repos are governed by our Community Participation Guidelines, available at: https://dyte.notion.site/dyte/Dyte-Community-Participation-Guidelines-CPG-4b3af58fdf3545c2a3065773a9154728
95 changes: 95 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# Contributing

Thanks for contributing! :smile:
We love contributions from everyone.
By participating in this project,
you agree to abide by our [code of conduct](./CODE_OF_CONDUCT.md).

The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

> Note: Contributions should be made via pull requests to the dev branch of the repository.
## Table of Contents

1. [Styleguides](#styleguides)
2. [What should I know before I get started?](#what-should-i-know-before-i-get-started)
3. [How Can I contribute?](#how-can-i-contribute)
4. [Code Contribution](#code-contribution)

# Guidelines

The following are the guidelines we request you to follow in order to contribute to this project.

## Styleguides

### Commit Messages

The commit messages should follow the following pattern:

```bash
feat: Description # if a new feature is added
fix: Description # if a bug is fixed
refactor: Description # if code is refactored
docs: Description # if documentation is added
lint: Description # if a lint issue is fixed
```

### Issues

```bash
update: Description # if an update is required for a feature
bug: Description # if there is a bug in a particular feature
suggestion: Description # if you want to suggest a better way to implement a feature
```

### Code Styleguide

The code should satisfy the following:

- Have meaningful variable names, either in `snake_case` or `camelCase`.
- Have no `lint` issues.
- Have meaningful file names, directory names and directory structure.
- Have a scope for easy fixing, refactoring and scaling.

## What should I know before I get started

You can contribute to any of the features you want, here's what you need to know:

- How the project works.
- The technology stack used for the project.
- A brief idea about writing documentation.

## How Can I Contribute

You can contribute by:

- Reporting Bugs
- Suggesting Enhancements
- Code Contribution
- Pull Requests

## Code Contribution

1. Checkout the latest `main` branch to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
2. Check the issue tracker to make sure someone already hasn't requested it and/or contributed to it.
3. Fork it!
4. Create your feature branch: `git checkout -b feature/my-new-feature`
5. Add your changes: `git add .`
6. Commit your changes: `git commit -am 'feat: Add some feature'`
7. Push to the branch: `git push -u origin feature/my-new-feature`
8. Submit a pull request :sunglasses:

### Pull Requests

Make sure to document the contributions well in the pull request.
Pull requests should have:

- A concise commit message.
- A description of what was changed/added.

Others will give constructive feedback.
This is a time for discussion and improvements,
and making the necessary changes will be required before we can
merge the contribution.

> It is not compulsory to follow the guidelines mentioned above, but it is strongly recommended.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.
118 changes: 118 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<!-- PROJECT LOGO -->
<p align="center">
<a href="https://dyte.io">
<img src="https://dyte-uploads.s3.ap-south-1.amazonaws.com/dyte-logo-dark.svg" alt="Logo" width="80">
</a>

<h2 align="center">iOS SDK by dyte</h2>

<p align="center">
iOS SDK for Dyte meetings via Cocoapods
<br />
<a href="https://docs.dyte.io"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://app.dyte.io">View Demo</a>
·
<a href="https://github.com/dyte-in/dyte-ios-sdk/issues">Report Bug</a>
·
<a href="https://github.com/dyte-in/dyte-ios-sdk/issues">Request Feature</a>
</p>
</p>

<!-- TABLE OF CONTENTS -->

## Table of Contents

- [About the Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Version History](#version-history)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Support](#support)
- [License](#license)
- [About](#about)

<!-- ABOUT THE PROJECT -->

## About The Project

This is the Cocoapods repository for Dyte's iOS SDK, which can be used in iOS apps to add a live audio / video experience.

### Built With

- [Objective-C](https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html)
- [WebRTC](https://webrtc.github.io/webrtc-org/native-code/ios/)
- [Cocoapods](https://cocoapods.org)
- :heart:
- ☕️

<!-- GETTING STARTED -->

## Getting Started

To integrate with an existing app, follow these simple steps.

### Prerequisites

- Xcode (with `Rossetta` enabled on Apple Silicon Macs)
- Cocoapods (refer https://cocoapods.org/ for further help)

```sh
sudo gem install cocoapods
```

- Existing iOS project, where you would like to add Dyte SDK

### Installation

Check out our documentation [here for installation instructions](https://docs.dyte.io/ios/installation).

<!-- USAGE EXAMPLES -->

## Usage

Check out our documentation [here for basic](https://docs.dyte.io/ios/usage) and [advanced usage instructions](https://docs.dyte.io/ios/advanced-usage).

<!-- CHANGELOG -->

## Version History

See [CHANGELOG](./CHANGELOG.md).

<!-- ROADMAP -->

## Roadmap

See the [open issues](https://github.com/dyte-in/dyte-ios-sdk/issues) for a list of proposed features (and known issues).

<!-- CONTRIBUTING -->

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Sincere thanks to all [our contributors](https://github.com/dyte-in/dyte-ios-sdk/graphs/contributors)!

You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) and code of conduct at [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) while contributing to the project :smile:.

## Support

Contributions, issues, and feature requests are welcome!
Give a ⭐️ if you like this project!

<!-- LICENSE -->

## License

Distributed under the Apache License, Version 2.0. See [`LICENSE`](./LICENSE) for more information.

## About

`dyte-ios-sdk` is created & maintained by Dyte, Inc. You can find us on Twitter - [@dyte_io](twitter.com/dyte_io) or write to us at `dev [at] dyte.io`.

The names and logos for Dyte are trademarks of Dyte, Inc.

We love open source software! See [our other projects](https://github.com/dyte-in) and [our products](https://dyte.io).

0 comments on commit f790ea5

Please sign in to comment.