Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme #2643

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
upgrades
  • Loading branch information
corsacca committed Jan 17, 2025
commit 37e1cad6bb0b2b27ce11d084afe9e5bd876c13a3
56 changes: 33 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -19,50 +19,60 @@
```
# Disciple.Tools

Disciple.Tools is a powerful CRM that boosts collaboration, clarity, and accountability for christian ministries seeking the growth and multiplication of disciples and churches.
For more information see the [Disciple.Tools website](https://disciple.tools) and [User Documentation](https://disciple.tools/docs).
Disciple.Tools is a free, open-source CRM specifically designed to support Christian ministries in managing discipleship, church growth, and outreach efforts. With powerful features like generational tracking, data visualization, and secure collaboration, Disciple.Tools is built to help ministries of all sizes grow and multiply. Fully customizable and mobile-friendly, it empowers teams to stay organized, accountable, and connected.

## Plateform
[Visit the Disciple.Tools website](https://disciple.tools) for more information or explore the [User Documentation](https://disciple.tools/docs) to get started.

Disciple.Tools is a WordPress Theme. Install WordPress anywhere and simply upload and activate the Disciple.Tools theme.
THen be sure to check out the [Disciple.Tools Plugins list](https://disciple.tools/plugins) for even more functionality.

## Platform

Disciple.Tools is built as a WordPress theme. To use it, simply install WordPress (on any host or local server) and upload the Disciple.Tools theme via the WordPress admin dashboard. This allows you to leverage WordPress’s powerful ecosystem and customize Disciple.Tools to fit your ministry's needs.

For additional functionality, explore the [Disciple.Tools Plugins list](https://disciple.tools/plugins) for integrations and extra features.

## Description

As a contact relationship management (CRM) system it is :
As a contact relationship management (CRM) system it is:

- free and open source – you have full control over your infrastructure and data
- unique – able to track and organize individuals or groups generationally
- insightful - giving end-to-end dashboards, charts, and maps on contacts, baptisms, groups, churches, and movements
- secure – restricting database access based on permission levels and specific assignments
- federated - designed to host how and where you want and inter-link instances as desired
- customizable – highly adaptable through settings, built-in modifications, external plugins, and requiring low-tech skills
- multilingual – translatable, facilitating cross-cultural collaboration
- mobile-friendly - giving full-functionality from a mobile device
- **Free & Open Source**: Full control over your data and infrastructure, without expensive user fees.
- **Generational Tracking**: Track discipleship across multiple generations and groups, making it easy to see the long-term impact.
- **Powerful Insights**: Visualize your data with end-to-end dashboards, charts, and maps covering contacts, baptisms, groups, and church movements.
- **Secure & Scalable**: Manage access based on roles and permissions, ensuring your data stays safe and private.
- **Federated Hosting**: Host your site wherever you prefer and link multiple instances together.
- **Highly Customizable**: Adapt the theme to your needs using built-in settings, plugins, and low-code modifications.
- **Mobile-Friendly**: Manage your ministry’s data on-the-go with full mobile functionality.
- **Multilingual Support**: Reach a global audience with easy translation and cross-cultural collaboration features.

## Origin

Disciple.Tools was started out of a need for a simple, low-cost, highly distributable CRM. Most other CRMs charge per user and are too expensive for to be used by small volunteer teams.


## Contribution

Missing Feature? Bug Fix? We'd love your help.
We're excited to have you contribute to Disciple.Tools! Whether you're fixing a bug, adding a feature, or improving documentation, we welcome your input.

Before coding and creating a PR please create or comment on an issue you'd like to work on. This will help others know you are working on it and avoid duplicate work.
A good place to start is the [help wanted GitHub Issues](https://github.com/DiscipleTools/disciple-tools-theme/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22help%20wanted%22).
### How to Contribute to the Theme
- **Create an Issue**: If you're planning to work on a new feature or fix a bug, please [create an issue](https://github.com/DiscipleTools/disciple-tools-theme/issues) first to discuss your plans, or comment on an existing issue.
- **Fork the Repo**: Once your issue is set, fork this repository and create a new branch for your work.
- **Make a Pull Request**: Once you've completed your changes, submit a pull request with a clear description of what you've done. Please make sure any theme and plugin contributions align with the [contributing guidelines](https://github.com/DiscipleTools/disciple-tools-theme/wiki/Contribution-guidelines).

Need help or want to brainstorm? Join our [discord channel](https://discord.gg/kp5pYmrhSd) and share your questions and ideas.
You can find open issues that need help under the [Help Wanted](https://github.com/DiscipleTools/disciple-tools-theme/issues?q=is%3Aissue%20label%3A%22help%20wanted%22) label.

### How to Contribute via a Plugin
We recommend building most new features in a plugin first. Later we can decide if it should be included in the core theme.
See the [starter plugin](https://github.com/DiscipleTools/disciple-tools-plugin-starter-template) for a good starting point.

Please make sure any theme and plugin contributions align with the [contributing guidelines](https://github.com/DiscipleTools/disciple-tools-theme/wiki/Contribution-guidelines).
- **Use the Starter Template**: Start by creating a GitHub repo using the [starter plugin template](https://github.com/DiscipleTools/disciple-tools-plugin-starter-template).
- **Customize the Plugin**: Use the [starter plugin wiki](https://github.com/DiscipleTools/disciple-tools-plugin-starter-template/wiki) to guide your development.
- **Submit Pour Plugin**: Once your plugin is ready, submit it for inclusion in the [Disciple.Tools Plugins list](https://disciple.tools/plugins).

Disciple.Tools provides a REST API and hooks to make custom development easier. Explore the [developer documentation](https://developers.disciple.tools/) to get started.

Disciple.Tools has a powerful REST API and many hooks to help you build your feature.
Find the documentation and help setting up your coding environment in the [developer documentation](https://developers.disciple.tools/).
Need help or want to brainstorm? Join our [discord channel](https://discord.gg/kp5pYmrhSd) and share your questions and ideas.

## How to responsibly disclose a security vulnerability

If you discover a security vulnerability in these WordPress plugins and/or themes, or in the website https://disciple.tools , please send an email to supportXXXXdisciple.tools , replacing XXXX with the @ symbol. We ask that you give us a reasonable amount of time to correct the issue before you make the vulnerability public. Please do not submit a GitHub issue or a GitHub pull request, as these are public.

## License

Disciple.Tools is licensed under the GNU General Public License v3.0. For more information, see the [license](./LICENSE.md) file.