Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dscpsyl authored Aug 9, 2022
1 parent a193319 commit 5a2d618
Showing 1 changed file with 67 additions and 12 deletions.
79 changes: 67 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<a name="readme-top"></a>

<div align="center">
<h1>
Sexpert Wordpress Plugin
Expand All @@ -11,30 +13,83 @@
<img alt="GitHub License" src="https://img.shields.io/github/license/dscpsyl/sexpert?label=License">
</div>

---

## Functions:

<!-- ABOUT THE PROJECT -->
## About The Project

A plugin specifically designed for sexinfoonline.com, a website hosted and maintained by students at University of California - Santa Barbara.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- GETTING STARTED -->
## Getting Started

This is a wordpress plugin that is not listed on the store. However, it can be installed manually.

### Prerequisites

- Wordpress
- Php

### Installation

1. Clone this repository into the `wp-admin/plugins` directory of your wordpress site.

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->
## Usage

Two new tabs will be available once installed: ***Sexpert*** & ***Sexpert Admin***. Sexpert Admin will be used for basic admin preferences. Sexpert is where the list and replies will be available to writers and editors. Every interaction will be wit the UI and some of the main features are listed here.

### Functions
* **Add inquiry** - *Creates a form for users to submit quesions to website writers.*
* **Claim inquiry** - *Writers can claim inquiries and keep track of which questions still need to be answered.*
* **Comment and respond to inquiry** - *Writers can respond directly to the question and an email will be sent to the questioner automatically.*

### TODO:
* Add beautiful alert
* Show comments
* Admin panel
* Fix issue with 'Simple Redirect 301' v.2.0.6
<p align="right">(<a href="#readme-top">back to top</a>)</p>


<!-- ROADMAP -->
## Roadmap

- [ ] Add beautiful alerts and push notifications to both pages.
- [ ] Show comment history and remove answered threads.
- [ ] Admin panel makeover
- [ ] Beautify
- [ ] Add role configuration
- [ ] Add home page configuration

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

---
<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Dependents:

---

## Contributors
<a href="https://github.com/dscpsyl/sexpert/graphs/contributors">
<img src="https://contrib.rocks/image?repo=dscpsyl/sexpert" />
</a>

---

> This plugin is developed and managed by *University of California - Santa Barbra* students with no relation to nor sponsorship from the university itself. All student, staff, and faculty policies of the university and its affiliates will be adhered.

0 comments on commit 5a2d618

Please sign in to comment.