Skip to content

docs: improve project discovery and trustworthy adoption guidance #2

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.

Sign up for GitHub

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

Merged
Priyanshu845438 merged 1 commit into from
Oct 16, 2026
Merged

docs: improve project discovery and trustworthy adoption guidance #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 26 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# NEXUS Sales Automation
# NEXUS — Python Sales Automation and HubSpot Workflows

> AI-assisted B2B sales automation for lead discovery, lead enrichment, personalized outreach, CRM synchronization, follow-ups, and social content workflows.

Expand All @@ -9,20 +9,28 @@

NEXUS is a Python sales automation workspace for B2B prospecting and outreach. It combines lead discovery, enrichment, ICP scoring, AI-assisted email personalization, HubSpot synchronization, follow-up scheduling, and social publishing behind a single master runner and a local Flask dashboard.

## Choose a starting point

Explore the [Flask dashboard](app.py), [lead and follow-up workflows](engine/),
and [configuration example](.env.example). Start locally with sample data and
review each integration before enabling email delivery or CRM updates.

For shared development practices, use the [Engineering Standards handbook](https://github.com/AcadifySolution/engineering-standards).

## Features

| Capability | Purpose |
| --- | --- |
| Lead discovery | Collect prospects from supported public sources and startup ecosystems |
| Lead enrichment | Normalize prospect fields and enrich contact information |
| ICP scoring | Rank prospects against configurable ideal-customer criteria |
| AI personalization | Generate prospect-specific outreach using an LLM provider |
| CRM sync | Push qualified contacts and enrichment fields into HubSpot |
| Email outreach | Send initial outreach through SMTP |
| Follow-up automation | Manage scheduled follow-up touches |
| Social automation | Generate and publish LinkedIn/Facebook content |
| Dashboard | Inspect leads, KPIs, configuration, execution status, calendar data, and logs |
| Dry-run mode | Preview automation without sending outreach or publishing posts |
| Capability | Purpose |
| -------------------- | ----------------------------------------------------------------------------- |
| Lead discovery | Collect prospects from supported public sources and startup ecosystems |
| Lead enrichment | Normalize prospect fields and enrich contact information |
| ICP scoring | Rank prospects against configurable ideal-customer criteria |
| AI personalization | Generate prospect-specific outreach using an LLM provider |
| CRM sync | Push qualified contacts and enrichment fields into HubSpot |
| Email outreach | Send initial outreach through SMTP |
| Follow-up automation | Manage scheduled follow-up touches |
| Social automation | Generate and publish LinkedIn/Facebook content |
| Dashboard | Inspect leads, KPIs, configuration, execution status, calendar data, and logs |
| Dry-run mode | Preview automation without sending outreach or publishing posts |

## Architecture

Expand Down Expand Up @@ -128,10 +136,12 @@ python3 run.py --generate
python3 run.py --clutch
python3 run.py --schedule

# Safe preview
python3 run.py --dry-run
# Preview social workflow only
python3 run.py --social-only --dry-run
```

`--dry-run` applies to the social workflow; it is not a global guarantee that other stages avoid external writes.

Before using commands that send email, update CRM records, or publish social content, verify credentials, recipients, rate limits, and campaign content.

## Environment configuration
Expand Down Expand Up @@ -195,13 +205,9 @@ For AI-assisted sales workflows:
- [Security Policy](SECURITY.md) — security reporting and handling
- [Contributing Guide](CONTRIBUTING.md) — development workflow

## Search topics

**sales automation, B2B sales automation, AI sales automation, lead generation, lead scraping, lead enrichment, sales outreach, cold email automation, AI email personalization, CRM automation, HubSpot integration, follow-up automation, social media automation, Python sales tools, Flask sales dashboard, startup lead generation, AI-assisted sales, sales pipeline automation.**

## License

See [LICENSE](LICENSE) for the applicable licensing terms.
See repository licensing terms (no standalone LICENSE file is included) for the applicable licensing terms.

---

Expand Down
Loading