Update readme + add jazzy yaml

This commit is contained in:
Loïc GRIFFIE 2019-02-27 19:19:52 +01:00
parent b5ec4dea98
commit 7d13c07691
4 changed files with 137 additions and 8 deletions

8
.jazzy.yaml Normal file
View File

@ -0,0 +1,8 @@
author: Move Upwards
author_url: https://github.com/MoveUpwards
github_url: https://github.com/MoveUpwards/Sejima
root_url: https://github.com/MoveUpwards
module: Sejima
output: docs
theme: fullwidth
xcodebuild_arguments: [-workspace, 'Sejima.xcworkspace', -scheme, 'Sejima iOS']

46
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hi@moveupwards.dev. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

49
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,49 @@
# Contribute to Sejima
First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to Sejima and its packages.
Before contributing, ensure that your effort is aligned with the project's roadmap by talking to the maintainers, especially if you are going to spend a lot of time on it. Feel free to [join us on Slack](http://moveupwards.slack.com) if you are interested in helping us or [drop us an email](mailto:hi@moveupwards.dev) if you are interested in working with us.
## Code of Conduct
This project and everyone participating in it is governed by the [Sejima Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [mailto:hi@moveupwards.dev](mailto:hi@moveupwards.dev).
## Open Development & Community Driven
Sejima is open-source under the [MIT license](https://github.com/moveupwards/sejima/blob/master/LICENSE.md). All the work done is available on GitHub.
The core team and the contributors send pull requests which go through the same validation process.
Every user can send a feature request using the [issues](https://github.com/moveupwards/sejima/issues/new?template=FEATURE_REQUEST.md) on GitHub. Feel free to upvote 👍 [existing feature request](https://github.com/moveupwards/sejima/projects)
## Repository Organization
We will do our best to keep the master branch as clean as possible, with tests passing all the times. However, it can happen that the master branch moves faster than the release cycle. To ensure you have the latest stable version, please refer to the [release on cocoapods](https://cocoapods.org/pods/sejima).
If you send a pull request, please do it against the `develop` branch. We are developing upcoming versions separately to ensure non-breaking changes from master to the latest stable major version.
***
## Setup Development Environment
To facilitate the contribution, we drastically reduce the amount of commands necessary to install the entire library. First of all, you need to check if you're using the [required versions of xcode and swift version](https://github.com/MoveUpwards/Sejima#requirements)
Then, please follow the instructions below:
#### 1. Fork the repository
[Go to the repository](https://github.com/MoveUpwards/Sejima) and fork it to your own GitHub account.
#### 2. Clone from your repository
```bash
git clone git@github.com:YOUR_USERNAME/sejima.git
```
## Reporting an issue
Before reporting an issue you need to make sure:
- You are experiencing a concrete technical issue with Sejima (ideas and feature proposals should happen [on Slack](http://moveupwards.slack.com)).
- You are not asking a question about how to use Sejima or about whether or not Sejima has a certain feature. For general help using Sejima, please refer to [the official Sejima documentation](https://moveupwards.github.io/Sejima/). For additional help, ask a question on [StackOverflow](http://stackoverflow.com/questions/tagged/sejima).
- You have already searched for related [issues](https://github.com/moveupwards/sejima/issues), and found none open (if you found a related _closed_ issue, please link to it in your post).
- Your issue title is concise, on-topic and polite.
- You can provide steps to reproduce this issue that others can follow.
- You have tried all the following (if relevant) and your issue remains.

View File

@ -18,23 +18,49 @@
## Installation
use [CocoaPods](https://cocoapods.org) with Podfile:
```shell
```swift
pod 'Sejima'
```
## Components
open your favorite terminal, go to your project root path:
### MUHeader
```shell
pod install
```
### MUTopBar
## Features
### MUButton
- **MUHeader:** Elegant, entirely customizable and fully extensible admin panel.
- **MUTopBar:** Reusable policies, CSRF, CORS, P3P, Xframe, XSS, and more.
- **MUButton:** Install auth system, content management, custom plugins, and more, in seconds.
- **MUHorizontalPager:** Built on top of Node.js, Strapi delivers amazing performances.
- **MUPageControl:** Use any front-end frameworks (React, Vue, Angular, etc.), mobile apps or even IoT.
- **MUTextField:** Scaffold projects and APIs on the fly.
### MUHorizontalPager
## Contributing
### MUPageControl
Please read our [Contributing Guide](./CONTRIBUTING.md) before submitting a Pull Request to the project.
### License
## Support
For more information on the upcoming version, please take a look to our [ROADMAP](https://github.com/MoveUpwards/Sejima/projects/).
#### Community support
For general help using Strapi, please refer to [the official Sejima documentation](https://moveupwards.github.io/Sejima/). For additional help, you can use one of this channel to ask question:
- [StackOverflow](http://stackoverflow.com/questions/tagged/sejima)
- [Slack](http://moveupwards.slack.com) (highly recommended for faster support)
- [GitHub](https://github.com/MoveUpwards/Sejima).
#### Professional support
We provide a full range of solutions to get better and faster results. We're always looking for the next challenge: consulting, training, develop mobile and web solution, etc.
[Drop us an email](mailto:support@moveupwards.dev) to see how we can help you.
## License
Folding cell is released under the MIT license.
See [LICENSE](./LICENSE) for details.